Class ReactNativeLDClient

The React Native LaunchDarkly client. Instantiate this class to create an instance of the ReactNativeLDClient and pass it to the LDProvider.

Example

const featureClient = new ReactNativeLDClient(MOBILE_KEY, AutoEnvAttributes.Enabled);

<LDProvider client={featureClient}>
  <Welcome />
</LDProvider>

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:50

Properties

`Private` _connectionManager

_connectionManager: ConnectionManager

`Readonly` autoEnvAttributes

autoEnvAttributes: AutoEnvAttributes

`Protected` dataManager

dataManager: DataManager

`Readonly` platform

platform: Platform

`Readonly` sdkKey

sdkKey: string

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:82

allFlags

allFlags(): LDFlagSet
Returns LDFlagSet
Inherited from LDClientImpl.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
Inherited from LDClientImpl.boolVariation
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:74

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:78

close

close(): Promise<void>
Returns Promise<void>
Inherited from LDClientImpl.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;
}>
Inherited from LDClientImpl.flush
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:36

getConnectionMode

getConnectionMode(): ConnectionMode
Gets the SDK connection mode.

Returns ConnectionMode
- Defined in packages/sdk/react-native/src/ReactNativeLDClient.ts:170

getContext

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

`Protected` getInternalContext

getInternalContext(): undefined | Context
Returns undefined | Context
Inherited from LDClientImpl.getInternalContext
- 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.

If used with the sheddable option set to true, then the identify operation will be sheddable. This means that if multiple identify operations are done, without waiting for the previous one to complete, then intermediate operations may be discarded.

It is recommended to use the identifyResult method instead when the operation is sheddable. In a future release, all identify operations will default to being sheddable.
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.
Inherited from LDClientImpl.identify
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:65

identifyResult

identifyResult(pristineContext, 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 JavaScript SDKs maintain 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 will still return flag values for the previous context. You can await the Promise to determine when the new flag values are available.

If used with the sheddable option set to true, then the identify operation will be sheddable. This means that if multiple identify operations are done, without waiting for the previous one to complete, then intermediate operations may be discarded.
Parameters
- pristineContext: LDContext
  
  The LDContext object.
- Optional identifyOptions: LDIdentifyOptions
  
  Optional configuration. Please see LDIdentifyOptions.
  
  Optional
Returns Promise<LDIdentifyResult>
A promise which resolves to an object containing the result of the identify operation. The promise returned from this method will not be rejected.
Inherited from LDClientImpl.identifyResult
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:66

isOffline

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

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:75

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:81

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:76

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:79

off

off(eventName, listener): void
Parameters
- eventName: LDEmitterEventName
- listener: Function
Returns void
Inherited from LDClientImpl.off
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:68

on

on(eventName, listener): void
Parameters
- eventName: LDEmitterEventName
- listener: Function
Returns void
Inherited from LDClientImpl.on
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:67

`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:89

setConnectionMode

setConnectionMode(mode): Promise<void>
Parameters
- mode: ConnectionMode
Returns Promise<void>
- Defined in packages/sdk/react-native/src/ReactNativeLDClient.ts:159

`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
Inherited from LDClientImpl.setEventSendingEnabled
- Defined in packages/shared/sdk-client/dist/esm/LDClientImpl.d.ts:88

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:77

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:80

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:69

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:71

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:72

Class ReactNativeLDClient

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

sdkKey: string

autoEnvAttributes: AutoEnvAttributes

options: LDOptions = {}

Returns ReactNativeLDClient

Properties

Private _connectionManager

Readonly autoEnvAttributes

Protected dataManager

Protected emitter

Protected Readonly environmentMetadata

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

getConnectionMode

Returns ConnectionMode

getContext

Returns undefined | 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

Parameters

key: string

defaultValue: unknown

Returns LDEvaluationDetailTyped<unknown>

numberVariation

Parameters

key: string

defaultValue: number

Returns number

numberVariationDetail

Parameters

key: string

`Private` _connectionManager

`Readonly` autoEnvAttributes

`Protected` dataManager

`Protected` emitter

`Protected` `Readonly` environmentMetadata

`Readonly` logger

`Readonly` platform

`Readonly` sdkKey

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

`Protected` getInternalContext

`Optional` identifyOptions: LDIdentifyOptions

`Optional` identifyOptions: LDIdentifyOptions

`Protected` sendEvent

`Protected` setEventSendingEnabled

`Optional` data: any

`Optional` metricValue: number

`Optional` defaultValue: any

`Optional` defaultValue: any