Class LDClientImpl

Hierarchy

LDClientImpl
- ReactNativeLDClient

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/dist/esm/LDClientImpl.d.ts:33

Properties

`Private` _baseHeaders

_baseHeaders: any

`Private` `Optional` _checkedContext

_checkedContext?: any

`Private` `Readonly` _config

_config: any

`Private` _createIdentifyPromise

_createIdentifyPromise: any

`Private` `Optional` `Readonly` _diagnosticsManager

_diagnosticsManager?: any

`Private` _eventFactoryDefault

_eventFactoryDefault: any

`Private` _eventFactoryWithReasons

_eventFactoryWithReasons: any

`Private` `Optional` _eventProcessor

_eventProcessor?: any

`Private` _eventSendingEnabled

_eventSendingEnabled: any

`Private` _flagManager

_flagManager: any

`Private` _handleInspectionChanged

_handleInspectionChanged: any

`Private` `Readonly` _highTimeoutThreshold

_highTimeoutThreshold: any

`Private` _hookRunner

_hookRunner: any

`Private` _identifyTimeout

_identifyTimeout: any

`Private` _inspectorManager

_inspectorManager: any

`Private` _typedEval

_typedEval: any

`Private` `Optional` _uncheckedContext

_uncheckedContext?: any

`Private` `Optional` _updateProcessor

_updateProcessor?: any

`Private` _variationInternal

_variationInternal: any

`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

addHook

addHook(hook): void
Parameters
- hook: Hook
Returns void
Implementation of LDClient.addHook
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:74

allFlags

allFlags(): LDFlagSet
Returns LDFlagSet
Implementation of LDClient.allFlags
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:34

boolVariation

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

boolVariationDetail

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

close

close(): Promise<void>
Returns Promise<void>
Implementation of LDClient.close
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:35

flush

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

getContext

getContext(): undefined | LDContext
Returns undefined | LDContext
Implementation of LDClient.getContext
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:40

`Protected` getInternalContext

getInternalContext(): undefined | Context
Returns undefined | Context
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:41

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/dist/esm/LDClientImpl.d.ts:58

jsonVariation

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

jsonVariationDetail

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

numberVariation

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

numberVariationDetail

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

off

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

on

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

`Protected` sendEvent

sendEvent(event): void
Parameters
- event: InputEvent
Returns void
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:81

`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/dist/esm/LDClientImpl.d.ts:80

stringVariation

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

stringVariationDetail

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

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/dist/esm/LDClientImpl.d.ts:61

variation

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

variationDetail

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

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 _createIdentifyPromise

Private Optional Readonly _diagnosticsManager

Private _eventFactoryDefault

Private _eventFactoryWithReasons

Private Optional _eventProcessor

Private _eventSendingEnabled

Private _flagManager

Private _handleInspectionChanged

Private Readonly _highTimeoutThreshold

Private _hookRunner

Private _identifyTimeout

Private _inspectorManager

Private _typedEval

Private Optional _uncheckedContext

Private Optional _updateProcessor

Private _variationInternal

Readonly autoEnvAttributes

Protected dataManager

Protected emitter

Readonly logger

Readonly platform

Readonly sdkKey

Methods

addHook

Parameters

hook: Hook

Returns void

allFlags

Returns LDFlagSet

boolVariation

Parameters

key: string

defaultValue: boolean

Returns boolean

boolVariationDetail

Parameters

key: string

defaultValue: boolean

Returns LDEvaluationDetailTyped<boolean>

close

Returns Promise<void>

flush

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

getContext

Returns undefined | LDContext

Protected getInternalContext

Returns undefined | Context

identify

Parameters

pristineContext: LDContext

Optional identifyOptions: LDIdentifyOptions

Returns Promise<void>

jsonVariation

Parameters

key: string

defaultValue: unknown

Returns unknown

jsonVariationDetail

Parameters

`Optional` internalOptions: LDClientInternalOptions

`Private` _baseHeaders

`Private` `Optional` _checkedContext

`Private` `Readonly` _config

`Private` _createIdentifyPromise

`Private` `Optional` `Readonly` _diagnosticsManager

`Private` _eventFactoryDefault

`Private` _eventFactoryWithReasons

`Private` `Optional` _eventProcessor

`Private` _eventSendingEnabled

`Private` _flagManager

`Private` _handleInspectionChanged

`Private` `Readonly` _highTimeoutThreshold

`Private` _hookRunner

`Private` _identifyTimeout

`Private` _inspectorManager

`Private` _typedEval

`Private` `Optional` _uncheckedContext

`Private` `Optional` _updateProcessor

`Private` _variationInternal

`Readonly` autoEnvAttributes

`Protected` dataManager

`Protected` emitter

`Readonly` logger

`Readonly` platform

`Readonly` sdkKey

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

`Protected` getInternalContext

`Optional` identifyOptions: LDIdentifyOptions

`Protected` sendEvent

`Protected` setEventSendingEnabled

`Optional` data: any

`Optional` metricValue: number

`Optional` defaultValue: any

`Optional` defaultValue: any