Class LDClientImpl

Hierarchy

LDClientImpl
- ReactNativeLDClient

Implements

LDClient

Constructors

constructor

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

Properties

`Readonly` autoEnvAttributes

autoEnvAttributes: AutoEnvAttributes

`Private` `Readonly` clientContext

clientContext: any

config

config: default

`Optional` context

context?: LDContext

`Private` createIdentifyPromise

createIdentifyPromise: any

`Private` createStreamListeners

createStreamListeners: any

`Optional` diagnosticsManager

diagnosticsManager?: DiagnosticsManager

`Private` emitter

emitter: any

`Private` eventFactoryDefault

eventFactoryDefault: any

`Private` eventFactoryWithReasons

eventFactoryWithReasons: any

`Optional` eventProcessor

eventProcessor?: EventProcessor

`Private` flags

flags: any

`Private` getFlagsFromStorage

getFlagsFromStorage: any

`Readonly` highTimeoutThreshold

highTimeoutThreshold: number

identifyTimeout

identifyTimeout: number

logger

logger: LDLogger

`Private` onIdentifyResolve

onIdentifyResolve: any

Performs common tasks when resolving the identify promise:

resolve the promise
update in memory context
update in memory flags
emit change event if needed

Param

Param

Param

Param

For logging purposes

`Readonly` platform

platform: Platform

`Readonly` sdkKey

sdkKey: string

`Optional` streamer

streamer?: StreamingProcessor

`Private` typedEval

typedEval: any

`Private` variationInternal

variationInternal: any

Methods

allFlags

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

boolVariation

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

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/LDClientImpl.d.ts:102

close

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

`Protected` createStreamUriPath

createStreamUriPath(_context): string
Protected
Generates the url path for streamer.

For mobile key: /meval/${base64-encoded-context} For clientSideId: /eval/${envId}/${base64-encoded-context}

the path.

This function must be overridden in subclasses for streamer to work.
Parameters
- _context: LDContext
  
  The LDContext object
Returns string
- Defined in packages/shared/sdk-client/dist/LDClientImpl.d.ts:58

flush

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

getConnectionMode

getConnectionMode(): ConnectionMode
Gets the SDK connection mode.

Returns ConnectionMode
Implementation of LDClient.getConnectionMode
- Defined in packages/shared/sdk-client/dist/LDClientImpl.d.ts:36

getContext

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

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 LDIdentifyOptions | identifyOptions.
3. A network error is encountered during initialization.
Implementation of LDClient.identify
- Defined in packages/shared/sdk-client/dist/LDClientImpl.d.ts:76

isOffline

isOffline(): boolean
Returns boolean
- Defined in packages/shared/sdk-client/dist/LDClientImpl.d.ts:37

jsonVariation

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

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/LDClientImpl.d.ts:105

numberVariation

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

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/LDClientImpl.d.ts:103

off

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

on

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

setConnectionMode

setConnectionMode(mode): Promise<void>
Sets the SDK connection mode.
Parameters
- mode: ConnectionMode
  
  One of supported ConnectionMode. Default is 'streaming'.
Returns Promise<void>
Implementation of LDClient.setConnectionMode
- Defined in packages/shared/sdk-client/dist/LDClientImpl.d.ts:32

stringVariation

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

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/LDClientImpl.d.ts:104

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/LDClientImpl.d.ts:93

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/LDClientImpl.d.ts:95

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/LDClientImpl.d.ts:96

Generated using TypeDoc