Interface ISDKConfiguration

interface ISDKConfiguration {
    apiKey: string;
    authKey: string;
    defaultDataCollection?: ISDKDefaultDataCollectionConfiguration;
    defaultIcon?: string;
    dev: boolean;
    enableHashFeatures?: boolean;
    migrations?: ISDKMigrationsConfiguration;
    safari?: ISafariConfig;
    serviceWorker?: ISDKServiceWorkerConfiguration;
    smallIcon?: string;
    subdomain?: string;
    ui?: null | ISDKUIConfiguration;
    vapidPublicKey?: string;
}

Properties

apiKey: string
authKey: string

Default data collection related configuration

defaultIcon?: string
dev: boolean
enableHashFeatures?: boolean

Enable features that are triggered using a hash in the URL. Default: true

Migrations related configuration

safari?: ISafariConfig

Service Worker related configuration

smallIcon?: string
subdomain?: string
vapidPublicKey?: string