Class ReactNativeLDClient

Hierarchy

LDClientImpl
- ReactNativeLDClient

Constructors

constructor

new ReactNativeLDClient(sdkKey, autoEnvAttributes, options?): ReactNativeLDClient
Creates an instance of the LaunchDarkly client.
Parameters
- sdkKey: string
  
  The LaunchDarkly mobile key.
- autoEnvAttributes: AutoEnvAttributes
  
  Enable / disable Auto environment attributes. When enabled, the SDK will automatically provide data about the mobile environment where the application is running. To learn more, read Automatic environment attributes. for more documentation.
- options: LDOptions = {}
  
  LDOptions to initialize the client with.
Returns ReactNativeLDClient
Overrides LDClientImpl.constructor
- Defined in packages/sdk/react-native/src/ReactNativeLDClient.ts:89

Properties

`Private` `Optional` _connectionManager

_connectionManager?: ConnectionManager

`Private` `Optional` _stateDetector

_stateDetector?: default

`Readonly` autoEnvAttributes

autoEnvAttributes: AutoEnvAttributes

`Protected` dataManager

dataManager: DataManager

`Protected` `Optional` initResolve

initResolve?: ((result) => void)

Type declaration

- (result): void
- Parameters
  - result: LDWaitForInitializationResult
  Returns void

`Protected` `Optional` initialContext

initialContext?: LDContext

`Protected` `Optional` initializeResult

initializeResult?: LDWaitForInitializationResult

`Protected` `Optional` initializedPromise

initializedPromise?: Promise<LDWaitForInitializationResult>

`Protected` `Readonly` isFDv2

isFDv2: boolean

`Readonly` logger

logger: LDLogger

`Readonly` platform

platform: Platform

`Readonly` sdkKey

sdkKey: string

`Protected` `Optional` startPromise

startPromise?: Promise<LDWaitForInitializationResult>

Methods

addHook

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

allFlags

allFlags(): LDFlagSet
Returns LDFlagSet
Inherited from LDClientImpl.allFlags
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:40

boolVariation

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

boolVariationDetail

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

close

close(): Promise<void>
Returns Promise<void>
Overrides LDClientImpl.close
- Defined in packages/sdk/react-native/src/ReactNativeLDClient.ts:232

flush

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

getConnectionMode

getConnectionMode(): ConnectionMode
Gets the SDK connection mode.

Returns ConnectionMode
- Defined in packages/sdk/react-native/src/ReactNativeLDClient.ts:290
getConnectionMode(): FDv2ConnectionMode
Gets the SDK connection mode.

When the FDv2 data system is enabled (dataSystem option), the connection mode may also be 'one-shot' or 'background'.

This overload is not stable, and not subject to any backwards compatibility guarantees or semantic versioning. It is in early access. If you want access to this feature please join the EAP. https://launchdarkly.com/docs/sdk/features/data-saving-mode

Returns FDv2ConnectionMode
- Defined in packages/sdk/react-native/src/ReactNativeLDClient.ts:302

getContext

getContext(): undefined | platform.LDContext
Returns undefined | platform.LDContext
Inherited from LDClientImpl.getContext
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:46

`Protected` getInternalContext

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

identify

identify(pristineContext, identifyOptions?): Promise<void>
Parameters
- pristineContext: LDContext
- Optional identifyOptions: LDIdentifyOptions
  Optional
Returns Promise<void>
Inherited from LDClientImpl.identify
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:52

identifyResult

identifyResult(pristineContext, identifyOptions?): Promise<LDIdentifyResult>
Parameters
- pristineContext: LDContext
- Optional identifyOptions: LDIdentifyOptions
  Optional
Returns Promise<LDIdentifyResult>
Inherited from LDClientImpl.identifyResult
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:53

isOffline

isOffline(): boolean
Returns boolean
- Defined in packages/sdk/react-native/src/ReactNativeLDClient.ts:310

jsonVariation

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

jsonVariationDetail

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

`Protected` maybeSetInitializationResult

maybeSetInitializationResult(result): void
Parameters
- result: LDWaitForInitializationResult
Returns void
Inherited from LDClientImpl.maybeSetInitializationResult
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:54

numberVariation

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

numberVariationDetail

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

off

off(eventName, listener): void
Parameters
- eventName: LDEmitterEventName
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      Rest
      
      Returns void
Returns void
Inherited from LDClientImpl.off
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:58

on

on(eventName, listener): void
Parameters
- eventName: LDEmitterEventName
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      Rest
      
      Returns void
Returns void
Inherited from LDClientImpl.on
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:57

`Protected` presetFlags

presetFlags(newFlags): void
Parameters
- newFlags: {
  [key: string]: ItemDescriptor;
  }
  - [key: string]: ItemDescriptor
Returns void
Inherited from LDClientImpl.presetFlags
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:48

`Protected` sendEvent

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

setConnectionMode

setConnectionMode(mode): Promise<void>
Sets the SDK connection mode.
Parameters
- mode: ConnectionMode
  
  The connection mode to use ('streaming', 'polling', or 'offline').
Returns Promise<void>
- Defined in packages/sdk/react-native/src/ReactNativeLDClient.ts:243
setConnectionMode(mode?): Promise<void>
Sets the connection mode for the FDv2 data system.

When the FDv2 data system is enabled (dataSystem option), this method additionally accepts 'one-shot' and 'background' modes. Pass undefined to clear an explicit override and return to automatic mode selection.

This overload is not stable, and not subject to any backwards compatibility guarantees or semantic versioning. It is in early access. If you want access to this feature please join the EAP. https://launchdarkly.com/docs/sdk/features/data-saving-mode
Parameters
- Optional mode: FDv2ConnectionMode
  
  The connection mode to use, or undefined to clear the override (FDv2 only).
  
  Optional
Returns Promise<void>
- Defined in packages/sdk/react-native/src/ReactNativeLDClient.ts:260

`Protected` setEventSendingEnabled

setEventSendingEnabled(enabled, flush): void
Parameters
- enabled: boolean
- flush: boolean
Returns void
Inherited from LDClientImpl.setEventSendingEnabled
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:73

start

start(options?): Promise<LDWaitForInitializationResult>
Parameters
- Optional options: LDStartOptions
  Optional
Returns Promise<LDWaitForInitializationResult>
Inherited from LDClientImpl.start
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:51

stringVariation

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

stringVariationDetail

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

track

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

variation

variation(flagKey, defaultValue?): any
Parameters
- flagKey: string
- Optional defaultValue: any
  Optional
Returns any
Inherited from LDClientImpl.variation
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:61

variationDetail

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

waitForInitialization

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

Class ReactNativeLDClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

sdkKey: string

autoEnvAttributes: AutoEnvAttributes

options: LDOptions = {}

Returns ReactNativeLDClient

Properties

Private Optional _connectionManager

Private Optional _stateDetector

Readonly autoEnvAttributes

Protected dataManager

Protected Optional Readonly dataSystemConfig

Protected emitter

Protected Readonly environmentMetadata

Protected Optional initResolve

Type declaration

Parameters

result: LDWaitForInitializationResult

Returns void

Protected Optional initialContext

Protected Optional initializeResult

Protected Optional initializedPromise

Protected Readonly isFDv2

Readonly logger

Readonly platform

Readonly sdkKey

Protected Optional startPromise

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

Returns FDv2ConnectionMode

getContext

Returns undefined | platform.LDContext

Protected getInternalContext

Returns undefined | Context

identify

Parameters

pristineContext: LDContext

Optional identifyOptions: LDIdentifyOptions

Returns Promise<void>

identifyResult

Parameters

pristineContext: LDContext

Optional identifyOptions: LDIdentifyOptions

Returns Promise<LDIdentifyResult>

isOffline

Returns boolean

jsonVariation

Parameters

key: string

defaultValue: unknown

Returns unknown

jsonVariationDetail

`Private` `Optional` _connectionManager

`Private` `Optional` _stateDetector

`Readonly` autoEnvAttributes

`Protected` dataManager

`Protected` `Optional` `Readonly` dataSystemConfig

`Protected` emitter

`Protected` `Readonly` environmentMetadata

`Protected` `Optional` initResolve

`Protected` `Optional` initialContext

`Protected` `Optional` initializeResult

`Protected` `Optional` initializedPromise

`Protected` `Readonly` isFDv2

`Readonly` logger

`Readonly` platform

`Readonly` sdkKey

`Protected` `Optional` startPromise

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

`Protected` getInternalContext

`Optional` identifyOptions: LDIdentifyOptions

`Optional` identifyOptions: LDIdentifyOptions

`Protected` maybeSetInitializationResult

`Rest` ...args: any[]

`Rest` ...args: any[]

`Protected` presetFlags

newFlags: {
[key: string]: ItemDescriptor;
}

`Protected` sendEvent

`Optional` mode: FDv2ConnectionMode

`Protected` setEventSendingEnabled

`Optional` options: LDStartOptions