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
Defined in
Properties
#customWrappers
• Private #customWrappers: HTMLElement[] = []
Defined in
config
• config: null | AdvantageConfig = null
Defined in
configurationRevision
• Private configurationRevision: number = 0
Defined in
defaultFormats
• defaultFormats: AdvantageFormat[] = defaultFormats
Defined in
formatIntegrations
• formatIntegrations: Map<string, AdvantageFormatIntegration>
Defined in
formats
• formats: Map<string, AdvantageFormat>
Defined in
loadingRevision
• Private loadingRevision: number = -1
Defined in
wrappers
• wrappers: IAdvantageWrapper[] = []
Defined in
id
▪ Static id: number = 0
Defined in
Accessors
isConfigLoading
• get isConfigLoading(): boolean
Whether the most recent configure call is loading remotely.
Returns
boolean
Defined in
Methods
applyConfig
▸ applyConfig(config, merge): void
Parameters
| Name | Type |
|---|---|
config | AdvantageConfig |
merge | boolean |
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
| Name | Type |
|---|---|
config | AdvantageConfig |
options | AdvantageConfigureOptions |
Returns
void
Defined in
loadConfig
▸ loadConfig(configUrl, merge, revision): void
Parameters
| Name | Type |
|---|---|
configUrl | string |
merge | boolean |
revision | number |
Returns
void
Defined in
src/advantage/advantage.ts:104
registerCustomWrapper
▸ registerCustomWrapper(wrapper): void
Parameters
| Name | Type |
|---|---|
wrapper | HTMLElement |
Returns
void
Defined in
registerWrapper
▸ registerWrapper(wrapper): void
Parameters
| Name | Type |
|---|---|
wrapper | IAdvantageWrapper |
Returns
void
Defined in
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
| Name | Type |
|---|---|
report | AdvantageSlotRenderReport |
Returns
boolean
Defined in
unregisterWrapper
▸ unregisterWrapper(wrapper): void
Parameters
| Name | Type |
|---|---|
wrapper | IAdvantageWrapper |
Returns
void
Defined in
getInstance
▸ getInstance(): Advantage