main overview

Added in v2.0.0

---

Table of contents

• capabilities
  • MainEnv (interface)
• methods
  • main
• model
  • SDK (interface)

---

capabilities

MainEnv (interface)

Defines capabilities and services required by the SDK’s main function.

Signature

export interface MainEnv
  extends GlobalsSvc,
    ProgramSvc,
    ConfigEnv,
    CustomerEnv,
    EventEnv {}

Added in v2.0.0

methods

main

Main function that starts and makes available the SDK features.

Signature

export declare const main: (E: MainEnv) => void;

Added in v2.0.0

model

SDK (interface)

SDK signature.

Signature

export interface SDK {
  (method: 'config', options: ConfigOptions): Promise<void>;
  (method: 'event', options: EventOptions): Promise<void>;
  (method: 'customer', options?: CustomerData): Promise<void>;
  q?: unknown[];
}

Added in v2.0.0