Skip to main content
Module

x/flagship_io_js_sdk/index.ts>Flagship

flagship-io/flagship-ts-sdk
Go to Latest
class Flagship
Re-export
import { Flagship } from "https://deno.land/x/flagship_io_js_sdk@3.0.11/index.ts";

Constructors

new
private
Flagship()

Properties

private
_config: IFlagshipConfig
private
_configManger: IConfigManager
private
_status: FlagshipStatus
private
optional
_visitorInstance: Visitor
private
configManager: IConfigManager

Methods

private
buildConfig(config?: IFlagshipConfig | FlagshipConfig): FlagshipConfig
private
buildDecisionManager(
flagship: Flagship,
config: FlagshipConfig,
httpClient: HttpClient,
): DecisionManager
protected
setStatus(status: FlagshipStatus): void
getConfig(): IFlagshipConfig

Return the current config set by the customer and used by the SDK.

getStatus(): FlagshipStatus

Return current status of Flagship SDK.

getVisitor(): Visitor | undefined

Return the last visitor created if isNewInstance key is false. Return undefined otherwise.

newVisitor(visitorId?: string | null, context?: Record<string, primitive>): Visitor | null

Create a new visitor with a context.

newVisitor(params?: NewVisitor): Visitor | null

Static Properties

private
_instance: Flagship

Static Methods

private
isReady(): boolean

Return true if the SDK is properly initialized, otherwise return false

protected
getInstance(): Flagship
getConfig(): IFlagshipConfig

Return the current config set by the customer and used by the SDK.

getStatus(): FlagshipStatus

Return current status of Flagship SDK.

getVisitor(): Visitor | undefined

Return the last visitor created if isNewInstance key is false. Return undefined otherwise.

newVisitor(visitorId?: string | null, context?: Record<string, primitive>): Visitor | null

Create a new visitor with a context.

newVisitor(params?: NewVisitor): Visitor | null

Create a new visitor with a context.

newVisitor(param1?: NewVisitor | string | null, param2?: Record<string, primitive>): Visitor | null
start(
envId: string,
apiKey: string,
config?: IFlagshipConfig | FlagshipConfig,
): Flagship | null

Start the flagship SDK, with a custom configuration implementation