Skip to content

highimpact.js / types / MergedIntegrationConfig

Interface: MergedIntegrationConfig ​

types.MergedIntegrationConfig

Merged configuration passed to format integration hooks. Combines Advantage framework config with High Impact JS global config.

Advantage properties (framework-level):

  • formats: Available format definitions
  • formatIntegrations: Other integration configurations
  • messageValidator: Security validation function
  • enableHighImpactCompatibility: Compatibility mode flag

High Impact JS properties (publisher-level):

  • plugins: Active plugins (e.g., ['gam', 'xandr'])
  • topBarHeight: Site header height in pixels
  • bottomBarHeight: Site footer height in pixels
  • zIndex: Custom z-index for ads
  • debug: Enable debug logging
  • ignoreSlotOn: Function to skip certain ads

Hierarchy ​

Properties ​

bottomBarHeight ​

• Optional bottomBarHeight: number

Defined in ​

src/types/index.ts:94


configUrlResolver ​

• Optional configUrlResolver: () => string

Type declaration ​

▸ (): string

Returns ​

string

Inherited from ​

Partial.configUrlResolver

Defined in ​

src/types/index.ts:28


debug ​

• Optional debug: boolean

Defined in ​

src/types/index.ts:97


enableHighImpactCompatibility ​

• Optional enableHighImpactCompatibility: boolean

Inherited from ​

Partial.enableHighImpactCompatibility

Defined in ​

src/types/index.ts:35


formatAgnosticCreatives ​

• Optional formatAgnosticCreatives: AdvantageFormatAgnosticCreatives

Enables format-agnostic High Impact JS creatives in the lean Advantage entry point.

The configuration shape may change before release.

Inherited from ​

Partial.formatAgnosticCreatives

Defined in ​

src/types/index.ts:42


formatIntegrations ​

• Optional formatIntegrations: AdvantageFormatIntegration[]

Inherited from ​

Partial.formatIntegrations

Defined in ​

src/types/index.ts:30


formats ​

• Optional formats: AdvantageFormat[]

Inherited from ​

Partial.formats

Defined in ​

src/types/index.ts:29


ignoreSlotOn ​

• Optional ignoreSlotOn: (html: string) => boolean

Type declaration ​

▸ (html): boolean

Parameters ​
NameType
htmlstring
Returns ​

boolean

Defined in ​

src/types/index.ts:96


messageValidator ​

• Optional messageValidator: (parentElement: HTMLElement | IAdvantageWrapper, message: MessageEvent<any>) => boolean

Type declaration ​

▸ (parentElement, message): boolean

Parameters ​
NameType
parentElementHTMLElement | IAdvantageWrapper
messageMessageEvent<any>
Returns ​

boolean

Inherited from ​

Partial.messageValidator

Defined in ​

src/types/index.ts:31


plugins ​

• Optional plugins: string[]

Defined in ​

src/types/index.ts:92


topBarHeight ​

• Optional topBarHeight: number

Defined in ​

src/types/index.ts:93


zIndex ​

• Optional zIndex: number

Defined in ​

src/types/index.ts:95