Class LDClient

The LaunchDarkly SDK edge client object.

Hierarchy

default
- LDClient

Constructors

constructor

new LDClient(clientSideID, platformInfo, options): LDClient
Parameters
- clientSideID: string
- platformInfo: Info
- options: LDOptions
Returns LDClient
Overrides LDClientImpl.constructor
- Defined in shared/sdk-server-edge/dist/cjs/src/api/LDClient.d.ts:9

Properties

`Protected` bigSegmentStatusProviderInternal

bigSegmentStatusProviderInternal: default

Intended for use by platform specific client implementations.

It is not included in the main interface because it requires the use of a platform event system. For node this would be an EventEmitter, for other platforms it would likely be an EventTarget.

emitter

emitter: EventEmitter<DefaultEventMap>

`Protected` environmentMetadata

environmentMetadata: LDPluginEnvironmentMetadata

Derived classes need to use this data to register plugins.

Accessors

logger

get logger(): undefined | LDLogger
Returns undefined | LDLogger
Inherited from LDClientImpl.logger
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:43

Methods

addHook

addHook(hook): void
Parameters
- hook: Hook
Returns void
Inherited from LDClientImpl.addHook
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:76

allFlagsState

allFlagsState(context, options?, callback?): Promise<LDFlagsState>
Parameters
- context: LDContext
- Optional options: LDFlagsStateOptions
  Optional
- Optional callback: ((err, res) => void)
  Optional
  - - (err, res): void
    - Parameters
      
      err: null | Error
      
      res: LDFlagsState
      
      Returns void
Returns Promise<LDFlagsState>
Inherited from LDClientImpl.allFlagsState
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:68

boolVariation

boolVariation(key, context, defaultValue): Promise<boolean>
Parameters
- key: string
- context: LDContext
- defaultValue: boolean
Returns Promise<boolean>
Inherited from LDClientImpl.boolVariation
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:58

boolVariationDetail

boolVariationDetail(key, context, defaultValue): Promise<LDEvaluationDetailTyped<boolean>>
Parameters
- key: string
- context: LDContext
- defaultValue: boolean
Returns Promise<LDEvaluationDetailTyped<boolean>>
Inherited from LDClientImpl.boolVariationDetail
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:62

close

close(): void
Returns void
Inherited from LDClientImpl.close
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:70

flush

flush(callback?): Promise<void>
Parameters
- Optional callback: ((err, res) => void)
  Optional
  - - (err, res): void
    - Parameters
      
      err: null | Error
      
      res: boolean
      
      Returns void
Returns Promise<void>
Inherited from LDClientImpl.flush
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:75

identify

identify(context): void
Parameters
- context: LDContext
Returns void
Inherited from LDClientImpl.identify
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:74

initialized

initialized(): boolean
Returns boolean
Inherited from LDClientImpl.initialized
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:53

isOffline

isOffline(): boolean
Returns boolean
Inherited from LDClientImpl.isOffline
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:71

jsonVariation

jsonVariation(key, context, defaultValue): Promise<unknown>
Parameters
- key: string
- context: LDContext
- defaultValue: unknown
Returns Promise<unknown>
Inherited from LDClientImpl.jsonVariation
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:61

jsonVariationDetail

jsonVariationDetail(key, context, defaultValue): Promise<LDEvaluationDetailTyped<unknown>>
Parameters
- key: string
- context: LDContext
- defaultValue: unknown
Returns Promise<LDEvaluationDetailTyped<unknown>>
Inherited from LDClientImpl.jsonVariationDetail
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:65

migrationVariation

migrationVariation(key, context, defaultValue): Promise<LDMigrationVariation>
Parameters
- key: string
- context: LDContext
- defaultValue: LDMigrationStage
Returns Promise<LDMigrationVariation>
Inherited from LDClientImpl.migrationVariation
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:67

numberVariation

numberVariation(key, context, defaultValue): Promise<number>
Parameters
- key: string
- context: LDContext
- defaultValue: number
Returns Promise<number>
Inherited from LDClientImpl.numberVariation
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:59

numberVariationDetail

numberVariationDetail(key, context, defaultValue): Promise<LDEvaluationDetailTyped<number>>
Parameters
- key: string
- context: LDContext
- defaultValue: number
Returns Promise<LDEvaluationDetailTyped<number>>
Inherited from LDClientImpl.numberVariationDetail
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:63

secureModeHash

secureModeHash(context): string
Parameters
- context: LDContext
Returns string
Inherited from LDClientImpl.secureModeHash
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:69

stringVariation

stringVariation(key, context, defaultValue): Promise<string>
Parameters
- key: string
- context: LDContext
- defaultValue: string
Returns Promise<string>
Inherited from LDClientImpl.stringVariation
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:60

stringVariationDetail

stringVariationDetail(key, context, defaultValue): Promise<LDEvaluationDetailTyped<string>>
Parameters
- key: string
- context: LDContext
- defaultValue: string
Returns Promise<LDEvaluationDetailTyped<string>>
Inherited from LDClientImpl.stringVariationDetail
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:64

track

track(key, context, data?, metricValue?): void
Parameters
- key: string
- context: LDContext
- Optional data: any
  Optional
- Optional metricValue: number
  Optional
Returns void
Inherited from LDClientImpl.track
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:72

trackMigration

trackMigration(event): void
Parameters
- event: LDMigrationOpEvent
Returns void
Inherited from LDClientImpl.trackMigration
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:73

variation

variation(key, context, defaultValue, callback?): Promise<any>
Parameters
- key: string
- context: LDContext
- defaultValue: any
- Optional callback: ((err, res) => void)
  Optional
  - - (err, res): void
    - Parameters
      
      err: any
      
      res: any
      
      Returns void
Returns Promise<any>
Inherited from LDClientImpl.variation
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:55

variationDetail

variationDetail(key, context, defaultValue, callback?): Promise<LDEvaluationDetail>
Parameters
- key: string
- context: LDContext
- defaultValue: any
- Optional callback: ((err, res) => void)
  Optional
  - - (err, res): void
    - Parameters
      
      err: any
      
      res: LDEvaluationDetail
      
      Returns void
Returns Promise<LDEvaluationDetail>
Inherited from LDClientImpl.variationDetail
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:56

waitForInitialization

waitForInitialization(options?): Promise<LDClient>
Parameters
- Optional options: LDWaitForInitializationOptions
  Optional
Returns Promise<LDClient>
Inherited from LDClientImpl.waitForInitialization
- Defined in shared/sdk-server/dist/LDClientImpl.d.ts:54

Class LDClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

clientSideID: string

platformInfo: Info

options: LDOptions

Returns LDClient

Properties

Protected bigSegmentStatusProviderInternal

emitter

Protected environmentMetadata

Accessors

logger

Returns undefined | LDLogger

Methods

addHook

Parameters

hook: Hook

Returns void

allFlagsState

Parameters

context: LDContext

Optional options: LDFlagsStateOptions

Optional callback: ((err, res) => void)

Parameters

err: null | Error

res: LDFlagsState

Returns void

Returns Promise<LDFlagsState>

boolVariation

Parameters

key: string

context: LDContext

defaultValue: boolean

Returns Promise<boolean>

boolVariationDetail

Parameters

key: string

context: LDContext

defaultValue: boolean

Returns Promise<LDEvaluationDetailTyped<boolean>>

close

Returns void

flush

Parameters

Optional callback: ((err, res) => void)

Parameters

err: null | Error

res: boolean

Returns void

Returns Promise<void>

identify

Parameters

context: LDContext

Returns void

initialized

Returns boolean

isOffline

Returns boolean

jsonVariation

Parameters

key: string

context: LDContext

defaultValue: unknown

Returns Promise<unknown>

jsonVariationDetail

Parameters

key: string

context: LDContext

defaultValue: unknown

Returns Promise<LDEvaluationDetailTyped<unknown>>

migrationVariation

Parameters

`Protected` bigSegmentStatusProviderInternal

`Protected` environmentMetadata

`Optional` options: LDFlagsStateOptions

`Optional` callback: ((err, res) => void)

`Optional` callback: ((err, res) => void)

`Optional` data: any

`Optional` metricValue: number

`Optional` callback: ((err, res) => void)

`Optional` callback: ((err, res) => void)

`Optional` options: LDWaitForInitializationOptions