Skip to main content
Module

x/flagship_io_js_sdk/mod.ts>IFlagshipConfig

flagship-io/flagship-ts-sdk
Go to Latest
interface IFlagshipConfig
Re-export
import { type IFlagshipConfig } from "https://deno.land/x/flagship_io_js_sdk@3.0.11/mod.ts";

Properties

optional
envId: string

Specify the environment id provided by Flagship, to use.

optional
apiKey: string

Specify the secure api key provided by Flagship, to use.

optional
timeout: number

Specify timeout in seconds for api request. Default is 2s.

optional
logLevel: LogLevel

Set the maximum log level to display

optional
decisionMode: DecisionMode

Specify the SDK running mode. BUCKETING or DECISION_API

optional
statusChangedCallback: (status: FlagshipStatus) => void

Define a callable in order to get callback when the SDK status has changed.

optional
logManager: IFlagshipLogManager

Specify a custom implementation of LogManager in order to receive logs from the SDK.

optional
fetchNow: boolean

Decide to fetch automatically modifications data when creating a new FlagshipVisitor

optional
pollingInterval: number

Specify delay between two bucketing polling. Default is 2s.

Note: If 0 is given then it should poll only once at start time.

optional
enableClientCache: boolean

Indicates whether enables or disables the client cache manager. By enabling the client cache, it will allow you to keep cross sessions visitor experience.

optional
onBucketingSuccess: (param: { status: number; payload: BucketingDTO; }) => void
optional
onBucketingFail: (error: Error) => void
optional
onBucketingUpdated: (lastUpdate: Date) => void
optional
initialBucketing: BucketingDTO
optional
decisionApiUrl: string
optional
activateDeduplicationTime: number
optional
hitDeduplicationTime: number
optional
visitorCacheImplementation: IVisitorCacheImplementation
optional
hitCacheImplementation: IHitCacheImplementation
optional
disableCache: boolean
optional
language: 0 | 1 | 2