Interface LDClient

Hierarchy

Omit<LDClientBase, "identify">
- LDClient

Properties

`Readonly` logger

logger: LDLogger

Methods

addHook

addHook(hook): void
Parameters
- hook: Hook
Returns void
Inherited from Omit.addHook
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:31

allFlags

allFlags(): LDFlagSet
Returns LDFlagSet
Inherited from Omit.allFlags
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:9

boolVariation

boolVariation(key, defaultValue): boolean
Parameters
- key: string
- defaultValue: boolean
Returns boolean
Inherited from Omit.boolVariation
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:10

boolVariationDetail

boolVariationDetail(key, defaultValue): LDEvaluationDetailTyped<boolean>
Parameters
- key: string
- defaultValue: boolean
Returns LDEvaluationDetailTyped<boolean>
Inherited from Omit.boolVariationDetail
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:11

close

close(): Promise<void>
Returns Promise<void>
Inherited from Omit.close
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:12

flush

flush(): Promise<{
error?: Error;
result: boolean;
}>
Returns Promise<{
error?: Error;
result: boolean;
}>
Inherited from Omit.flush
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:13

getConnectionMode

getConnectionMode(): ConnectionMode
Returns the current data source connection mode.

Returns ConnectionMode
- Defined in packages/sdk/node-client/src/LDClient.ts:59

getContext

getContext(): undefined | LDContextStrict
Returns undefined | LDContextStrict
Inherited from Omit.getContext
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:17

identify

identify(context, identifyOptions?): Promise<LDIdentifyResult>
Identifies a context to LaunchDarkly and returns a promise which resolves to an object containing the result of the identify operation.

Unlike the server-side SDKs, the client-side Node.js SDK maintains a current context state, which is set when you call identify().

Changing the current context also causes all feature flag values to be reloaded. Until that has finished, calls to variation methods will still return flag values for the previous context. You can await the Promise to determine when the new flag values are available.

Use start to set the initial context at startup.
Parameters
- context: LDContext
  
  The context to identify.
- Optional identifyOptions: LDIdentifyOptions
  
  Optional configuration.
  
  Optional
Returns Promise<LDIdentifyResult>
A promise which resolves to an object containing the result of the identify operation.
See
- LDContext
- LDIdentifyOptions.
- Defined in packages/sdk/node-client/src/LDClient.ts:33

isOffline

isOffline(): boolean
Returns true if the client is in offline mode.

Returns boolean
- Defined in packages/sdk/node-client/src/LDClient.ts:64

jsonVariation

jsonVariation(key, defaultValue): unknown
Parameters
- key: string
- defaultValue: unknown
Returns unknown
Inherited from Omit.jsonVariation
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:19

jsonVariationDetail

jsonVariationDetail(key, defaultValue): LDEvaluationDetailTyped<unknown>
Parameters
- key: string
- defaultValue: unknown
Returns LDEvaluationDetailTyped<unknown>
Inherited from Omit.jsonVariationDetail
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:20

numberVariation

numberVariation(key, defaultValue): number
Parameters
- key: string
- defaultValue: number
Returns number
Inherited from Omit.numberVariation
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:22

numberVariationDetail

numberVariationDetail(key, defaultValue): LDEvaluationDetailTyped<number>
Parameters
- key: string
- defaultValue: number
Returns LDEvaluationDetailTyped<number>
Inherited from Omit.numberVariationDetail
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:23

off

off(key, callback): void
Parameters
- key: string
- callback: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      Rest
      
      Returns void
Returns void
Inherited from Omit.off
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:24

on

on(key, callback): void
Parameters
- key: string
- callback: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      Rest
      
      Returns void
Returns void
Inherited from Omit.on
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:25

setConnectionMode

setConnectionMode(mode): Promise<void>
Sets the data source connection mode.
Parameters
- mode: ConnectionMode
Returns Promise<void>

Remarks
Switches between 'offline', 'streaming', and 'polling' at runtime without restarting the client. Use 'offline' to pause all LaunchDarkly network activity.

See
ConnectionMode
- Defined in packages/sdk/node-client/src/LDClient.ts:54

start

start(options?): Promise<LDWaitForInitializationResult>
Starts the client and returns a promise that resolves to the initialization result.

The promise will resolve to a LDWaitForInitializationResult object containing the status of the waitForInitialization operation.
Parameters
- Optional options: LDStartOptions
  
  Optional configuration. See LDStartOptions.
  
  Optional
Returns Promise<LDWaitForInitializationResult>
- Defined in packages/sdk/node-client/src/LDClient.ts:43

stringVariation

stringVariation(key, defaultValue): string
Parameters
- key: string
- defaultValue: string
Returns string
Inherited from Omit.stringVariation
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:26

stringVariationDetail

stringVariationDetail(key, defaultValue): LDEvaluationDetailTyped<string>
Parameters
- key: string
- defaultValue: string
Returns LDEvaluationDetailTyped<string>
Inherited from Omit.stringVariationDetail
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:27

track

track(key, data?, metricValue?): void
Parameters
- key: string
- Optional data: any
  Optional
- Optional metricValue: number
  Optional
Returns void
Inherited from Omit.track
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:28

variation

variation(key, defaultValue?): any
Parameters
- key: string
- Optional defaultValue: any
  Optional
Returns any
Inherited from Omit.variation
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:29

variationDetail

variationDetail(key, defaultValue?): LDEvaluationDetail
Parameters
- key: string
- Optional defaultValue: any
  Optional
Returns LDEvaluationDetail
Inherited from Omit.variationDetail
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:30

waitForInitialization

waitForInitialization(options?): Promise<LDWaitForInitializationResult>
Parameters
- Optional options: LDWaitForInitializationOptions
  Optional
Returns Promise<LDWaitForInitializationResult>
Inherited from Omit.waitForInitialization
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:32

Interface LDClient

Hierarchy

Index

Properties

Methods

Properties

Readonly logger

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; }>

getConnectionMode

Returns ConnectionMode

getContext

Returns undefined | LDContextStrict

identify

Parameters

context: LDContext

Optional identifyOptions: LDIdentifyOptions

Returns Promise<LDIdentifyResult>

See

isOffline

Returns boolean

jsonVariation

Parameters

key: string

defaultValue: unknown

Returns unknown

jsonVariationDetail

Parameters

key: string

defaultValue: unknown

Returns LDEvaluationDetailTyped<unknown>

numberVariation

Parameters

key: string

defaultValue: number

Returns number

numberVariationDetail

Parameters

key: string

defaultValue: number

Returns LDEvaluationDetailTyped<number>

off

Parameters

key: string

callback: ((...args) => void)

Parameters

Rest ...args: any[]

Returns void

Returns void

on

Parameters

key: string

callback: ((...args) => void)

Parameters

Rest ...args: any[]

Returns void

Returns void

setConnectionMode

Parameters

mode: ConnectionMode

Returns Promise<void>

`Readonly` logger

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

`Optional` identifyOptions: LDIdentifyOptions

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` options: LDStartOptions

`Optional` data: any

`Optional` metricValue: number

`Optional` defaultValue: any

`Optional` defaultValue: any

`Optional` options: LDWaitForInitializationOptions