Class LDClientImpl

Hierarchy

LDClientImpl

Implements

LDClient

Constructors

constructor

new LDClientImpl(sdkKey, autoEnvAttributes, platform, options, dataManagerFactory, internalOptions?): LDClientImpl
Creates the client object synchronously. No async, no network calls.
Parameters
- sdkKey: string
- autoEnvAttributes: AutoEnvAttributes
- platform: Platform
- options: LDOptions
- dataManagerFactory: DataManagerFactory
- Optional internalOptions: LDClientInternalOptions
  Optional
Returns LDClientImpl
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:69

Properties

`Private` _baseHeaders

_baseHeaders: LDHeaders

`Private` `Optional` _checkedContext

_checkedContext?: Context

`Private` `Readonly` _config

_config: Configuration

`Private` `Optional` `Readonly` _diagnosticsManager

_diagnosticsManager?: DiagnosticsManager

`Private` _eventFactoryDefault

_eventFactoryDefault: default = ...

`Private` _eventFactoryWithReasons

_eventFactoryWithReasons: default = ...

`Private` `Optional` _eventProcessor

_eventProcessor?: EventProcessor

`Private` _eventSendingEnabled

_eventSendingEnabled: boolean = false

`Private` _flagManager

_flagManager: FlagManager

`Private` `Readonly` _highTimeoutThreshold

_highTimeoutThreshold: number = 15

`Private` _hookRunner

_hookRunner: default

`Private` _inspectorManager

_inspectorManager: default

`Private` `Optional` _uncheckedContext

_uncheckedContext?: LDContext

`Private` `Optional` _updateProcessor

_updateProcessor?: LDStreamProcessor

`Readonly` autoEnvAttributes

autoEnvAttributes: AutoEnvAttributes

`Protected` dataManager

dataManager: DataManager

`Protected` emitter

emitter: LDEmitter

`Readonly` logger

logger: LDLogger

`Readonly` platform

platform: Platform

`Readonly` sdkKey

sdkKey: string

Methods

`Private` _createIdentifyPromise

_createIdentifyPromise(timeout, noTimeout): {
    identifyPromise: Promise<void>;
    identifyReject: ((err) => void);
    identifyResolve: (() => void);
}
Parameters
- timeout: number
- noTimeout: boolean
Returns {
    identifyPromise: Promise<void>;
    identifyReject: ((err) => void);
    identifyResolve: (() => void);
}
- identifyPromise: Promise<void>
- identifyReject: ((err) => void)
  - - (err): void
    - Parameters
      
      err: Error
      Returns void
- identifyResolve: (() => void)
  - - (): void
    - Returns void
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:185

`Private` _handleInspectionChanged

_handleInspectionChanged(flagKeys, type): void
Parameters
- flagKeys: string[]
- type: FlagChangeType
Returns void
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:501

`Private` _typedEval

_typedEval<T>(key, defaultValue, eventFactory, typeChecker): LDEvaluationDetailTyped<T>
Type Parameters
- T
Parameters
- key: string
- defaultValue: T
- eventFactory: default
- typeChecker: ((value) => [boolean, string])
  - - (value): [boolean, string]
    - Parameters
      
      value: unknown
      
      Returns [boolean, string]
Returns LDEvaluationDetailTyped<T>
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:400

`Private` _variationInternal

_variationInternal(flagKey, defaultValue, eventFactory, typeChecker?): LDEvaluationDetail
Parameters
- flagKey: string
- defaultValue: any
- eventFactory: default
- Optional typeChecker: ((value) => [boolean, string])
  Optional
  - - (value): [boolean, string]
    - Parameters
      
      value: any
      
      Returns [boolean, string]
Returns LDEvaluationDetail
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:314

addHook

addHook(hook): void
Parameters
- hook: Hook
Returns void
Implementation of LDClient.addHook
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:461

allFlags

allFlags(): LDFlagSet
Returns LDFlagSet
Implementation of LDClient.allFlags
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:139

boolVariation

boolVariation(key, defaultValue): boolean
Parameters
- key: string
- defaultValue: boolean
Returns boolean
Implementation of LDClient.boolVariation
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:411

boolVariationDetail

boolVariationDetail(key, defaultValue): LDEvaluationDetailTyped<boolean>
Parameters
- key: string
- defaultValue: boolean
Returns LDEvaluationDetailTyped<boolean>
Implementation of LDClient.boolVariationDetail
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:436

close

close(): Promise<void>
Returns Promise<void>
Implementation of LDClient.close
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:153

flush

flush(): Promise<{
error?: Error;
result: boolean;
}>
Returns Promise<{
error?: Error;
result: boolean;
}>
Implementation of LDClient.flush
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:160

getContext

getContext(): undefined | LDContext
Returns undefined | LDContext
Implementation of LDClient.getContext
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:172

`Protected` getInternalContext

getInternalContext(): undefined | Context
Returns undefined | Context
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:181

identify

identify(pristineContext, identifyOptions?): Promise<void>
Identifies a context to LaunchDarkly. See LDClient.identify.
Parameters
- pristineContext: LDContext
  
  The LDContext object to be identified.
- Optional identifyOptions: LDIdentifyOptions
  
  Optional configuration. See LDIdentifyOptions.
  
  Optional
Returns Promise<void>
A Promise which resolves when the flag values for the specified context are available. It rejects when:
1. The context is unspecified or has no key.
2. The identify timeout is exceeded. In client SDKs this defaults to 5s. You can customize this timeout with identifyOptions.
3. A network error is encountered during initialization.
Implementation of LDClient.identify
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:231

jsonVariation

jsonVariation(key, defaultValue): unknown
Parameters
- key: string
- defaultValue: unknown
Returns unknown
Implementation of LDClient.jsonVariation
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:418

jsonVariationDetail

jsonVariationDetail(key, defaultValue): LDEvaluationDetailTyped<unknown>
Parameters
- key: string
- defaultValue: unknown
Returns LDEvaluationDetailTyped<unknown>
Implementation of LDClient.jsonVariationDetail
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:457

numberVariation

numberVariation(key, defaultValue): number
Parameters
- key: string
- defaultValue: number
Returns number
Implementation of LDClient.numberVariation
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:422

numberVariationDetail

numberVariationDetail(key, defaultValue): LDEvaluationDetailTyped<number>
Parameters
- key: string
- defaultValue: number
Returns LDEvaluationDetailTyped<number>
Implementation of LDClient.numberVariationDetail
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:443

off

off(eventName, listener): void
Parameters
- eventName: LDEmitterEventName
- listener: Function
Returns void
Implementation of LDClient.off
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:292

on

on(eventName, listener): void
Parameters
- eventName: LDEmitterEventName
- listener: Function
Returns void
Implementation of LDClient.on
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:288

`Protected` sendEvent

sendEvent(event): void
Parameters
- event: InputEvent
Returns void
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:497

`Protected` setEventSendingEnabled

setEventSendingEnabled(enabled, flush): void
Enable/Disable event sending.
Parameters
- enabled: boolean
  
  True to enable event processing, false to disable.
- flush: boolean
  
  True to flush while disabling. Useful to flush on certain state transitions.
Returns void
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:470

stringVariation

stringVariation(key, defaultValue): string
Parameters
- key: string
- defaultValue: string
Returns string
Implementation of LDClient.stringVariation
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:429

stringVariationDetail

stringVariationDetail(key, defaultValue): LDEvaluationDetailTyped<string>
Parameters
- key: string
- defaultValue: string
Returns LDEvaluationDetailTyped<string>
Implementation of LDClient.stringVariationDetail
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:450

track

track(key, data?, metricValue?): void
Parameters
- key: string
- Optional data: any
  Optional
- Optional metricValue: number
  Optional
Returns void
Implementation of LDClient.track
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:296

variation

variation(flagKey, defaultValue?): any
Parameters
- flagKey: string
- Optional defaultValue: any
  Optional
Returns any
Implementation of LDClient.variation
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:385

variationDetail

variationDetail(flagKey, defaultValue?): LDEvaluationDetail
Parameters
- flagKey: string
- Optional defaultValue: any
  Optional
Returns LDEvaluationDetail
Implementation of LDClient.variationDetail
- Defined in packages/shared/sdk-client/src/LDClientImpl.ts:394

Class LDClientImpl

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

sdkKey: string

autoEnvAttributes: AutoEnvAttributes

platform: Platform

options: LDOptions

dataManagerFactory: DataManagerFactory

Optional internalOptions: LDClientInternalOptions

Returns LDClientImpl

Properties

Private _baseHeaders

Private Optional _checkedContext

Private Readonly _config

Private Optional Readonly _diagnosticsManager

Private _eventFactoryDefault

Private _eventFactoryWithReasons

Private Optional _eventProcessor

Private _eventSendingEnabled

Private _flagManager

Private Readonly _highTimeoutThreshold

Private _hookRunner

Private _inspectorManager

Private Optional _uncheckedContext

Private Optional _updateProcessor

Readonly autoEnvAttributes

Protected dataManager

Protected emitter

Readonly logger

Readonly platform

Readonly sdkKey

Methods

Private _createIdentifyPromise

Parameters

timeout: number

noTimeout: boolean

Returns { identifyPromise: Promise<void>; identifyReject: ((err) => void); identifyResolve: (() => void); }

identifyPromise: Promise<void>

identifyReject: ((err) => void)

Parameters

err: Error

Returns void

identifyResolve: (() => void)

Returns void

Private _handleInspectionChanged

Parameters

flagKeys: string[]

type: FlagChangeType

Returns void

Private _typedEval

Type Parameters

T

Parameters

key: string

defaultValue: T

eventFactory: default

typeChecker: ((value) => [boolean, string])

Parameters

value: unknown

Returns [boolean, string]

Returns LDEvaluationDetailTyped<T>

Private _variationInternal

Parameters

flagKey: string

defaultValue: any

eventFactory: default

Optional typeChecker: ((value) => [boolean, string])

Parameters

value: any

Returns [boolean, string]

Returns LDEvaluationDetail

addHook

Parameters

`Optional` internalOptions: LDClientInternalOptions

`Private` _baseHeaders

`Private` `Optional` _checkedContext

`Private` `Readonly` _config

`Private` `Optional` `Readonly` _diagnosticsManager

`Private` _eventFactoryDefault

`Private` _eventFactoryWithReasons

`Private` `Optional` _eventProcessor

`Private` _eventSendingEnabled

`Private` _flagManager

`Private` `Readonly` _highTimeoutThreshold

`Private` _hookRunner

`Private` _inspectorManager

`Private` `Optional` _uncheckedContext

`Private` `Optional` _updateProcessor

`Readonly` autoEnvAttributes

`Protected` dataManager

`Protected` emitter

`Readonly` logger

`Readonly` platform

`Readonly` sdkKey

`Private` _createIdentifyPromise

Returns {
identifyPromise: Promise<void>;
identifyReject: ((err) => void);
identifyResolve: (() => void);
}

`Private` _handleInspectionChanged

`Private` _typedEval

`Private` _variationInternal

`Optional` typeChecker: ((value) => [boolean, string])

Returns Promise<{
error?: Error;
result: boolean;
}>

`Protected` getInternalContext

`Optional` identifyOptions: LDIdentifyOptions

`Protected` sendEvent

`Protected` setEventSendingEnabled