Skip to content

highimpact.js / advantage/advantage / Advantage

Class: Advantage ​

advantage/advantage.Advantage

The main class for the Advantage library. This class is a singleton and is used to configure the library, register wrappers, and register custom elements.

Constructors ​

constructor ​

• new Advantage(): Advantage

Returns ​

Advantage

Defined in ​

src/advantage/advantage.ts:32

Properties ​

#customWrappers ​

• Private #customWrappers: HTMLElement[] = []

Defined in ​

src/advantage/advantage.ts:25


config ​

• config: null | AdvantageConfig = null

Defined in ​

src/advantage/advantage.ts:22


configurationRevision ​

• Private configurationRevision: number = 0

Defined in ​

src/advantage/advantage.ts:29


defaultFormats ​

• defaultFormats: AdvantageFormat[] = defaultFormats

Defined in ​

src/advantage/advantage.ts:23


formatIntegrations ​

• formatIntegrations: Map<string, AdvantageFormatIntegration>

Defined in ​

src/advantage/advantage.ts:27


formats ​

• formats: Map<string, AdvantageFormat>

Defined in ​

src/advantage/advantage.ts:26


loadingRevision ​

• Private loadingRevision: number = -1

Defined in ​

src/advantage/advantage.ts:30


wrappers ​

• wrappers: IAdvantageWrapper[] = []

Defined in ​

src/advantage/advantage.ts:24


id ​

▪ Static id: number = 0

Defined in ​

src/advantage/advantage.ts:28

Accessors ​

isConfigLoading ​

• get isConfigLoading(): boolean

Whether the most recent configure call is loading remotely.

Returns ​

boolean

Defined in ​

src/advantage/advantage.ts:62

Methods ​

applyConfig ​

▸ applyConfig(config, merge): void

Parameters ​

NameType
configAdvantageConfig
mergeboolean

Returns ​

void

Defined in ​

src/advantage/advantage.ts:122


configure ​

▸ configure(config, options?): void

Shallow-merge supplied top-level settings. Omitted keys survive; arrays and nested objects are replaced. Explicit undefined clears a setting. Use { merge: false } to replace the configuration entirely.

A resolver loads a default-exported config instead of applying local settings. Any newer configure call supersedes that pending load.

Parameters ​

NameType
configAdvantageConfig
optionsAdvantageConfigureOptions

Returns ​

void

Defined in ​

src/advantage/advantage.ts:44


loadConfig ​

▸ loadConfig(configUrl, merge, revision): void

Parameters ​

NameType
configUrlstring
mergeboolean
revisionnumber

Returns ​

void

Defined in ​

src/advantage/advantage.ts:104


registerCustomWrapper ​

▸ registerCustomWrapper(wrapper): void

Parameters ​

NameType
wrapperHTMLElement

Returns ​

void

Defined in ​

src/advantage/advantage.ts:82


registerWrapper ​

▸ registerWrapper(wrapper): void

Parameters ​

NameType
wrapperIAdvantageWrapper

Returns ​

void

Defined in ​

src/advantage/advantage.ts:67


reportSlotRendered ​

▸ reportSlotRendered(report): boolean

Reports the size selected by an ad server for a wrapped slot. This is paired with a format-agnostic creative's AD_RENDERED signal before a format is activated.

The format-agnostic creative API may change before release.

Parameters ​

NameType
reportAdvantageSlotRenderReport

Returns ​

boolean

Defined in ​

src/advantage/advantage.ts:94


unregisterWrapper ​

▸ unregisterWrapper(wrapper): void

Parameters ​

NameType
wrapperIAdvantageWrapper

Returns ​

void

Defined in ​

src/advantage/advantage.ts:73


getInstance ​

▸ getInstance(): Advantage

Returns ​

Advantage

Defined in ​

src/advantage/advantage.ts:99