@get-advantage/advantage / types / AdvantageFormat

Interface: AdvantageFormat

types.AdvantageFormat

Properties

close

• Optional close: (wrapper: IAdvantageWrapper, adIframe?: HTMLElement) => void

Type declaration

▸ (wrapper, adIframe?): void

Parameters

Name	Type
wrapper	IAdvantageWrapper
adIframe?	HTMLElement

Returns

void

Defined in

src/types/index.ts:80

---

description

• description: string

Defined in

src/types/index.ts:73

---

name

• name: string

Defined in

src/types/index.ts:72

---

reset

• reset: (wrapper: IAdvantageWrapper, adIframe?: HTMLElement) => void

Type declaration

▸ (wrapper, adIframe?): void

Parameters

Name	Type
wrapper	IAdvantageWrapper
adIframe?	HTMLElement

Returns

void

Defined in

src/types/index.ts:79

---

setup

• setup: (wrapper: IAdvantageWrapper, adIframe?: HTMLElement, options?: AdvantageFormatOptions) => Promise<void>

Type declaration

▸ (wrapper, adIframe?, options?): Promise<void>

Parameters

Name	Type
wrapper	IAdvantageWrapper
adIframe?	HTMLElement
options?	AdvantageFormatOptions

Returns

Promise<void>

Defined in

src/types/index.ts:74

---

simulate

• Optional simulate: (wrapper: IAdvantageWrapper) => void

Type declaration

▸ (wrapper): void

Parameters

Name	Type
wrapper	IAdvantageWrapper

Returns

void

Defined in

src/types/index.ts:81