Interface LDOptions

Hierarchy

  • LDOptions
  • RNSpecificOptions
    • LDOptions

Properties

allAttributesPrivate? applicationInfo? automaticBackgroundHandling? automaticNetworkHandling? baseUri? capacity? cleanOldPersistentData? dataSystem? debug? diagnosticOptOut? diagnosticRecordingInterval? disableCache? eventsUri? flushInterval? hooks? initialConnectionMode? inspectors? logger? maxCachedContexts? payloadFilterKey? plugins? pollInterval? privateAttributes? runInBackground? sendEvents? storage? streamInitialReconnectDelay? streamUri? useReport? withReasons? wrapperName? wrapperVersion?

Properties

Optional allAttributesPrivate

allAttributesPrivate?: boolean

Optional applicationInfo

applicationInfo?: {
    id?: string;
    name?: string;
    version?: string;
    versionName?: string;
}

Type declaration

  • Optional id?: string
  • Optional name?: string
  • Optional version?: string
  • Optional versionName?: string

Optional Readonly automaticBackgroundHandling

automaticBackgroundHandling?: boolean

Enable handling associated with transitioning between the foreground and background.

Defaults to true.

Optional Readonly automaticNetworkHandling

automaticNetworkHandling?: boolean

Enable handling of network availability. When this is true the connection state will automatically change when network availability changes.

Defaults to true.

Optional baseUri

baseUri?: string

Optional capacity

capacity?: number

Optional cleanOldPersistentData

cleanOldPersistentData?: boolean

Optional dataSystem

dataSystem?: LDClientDataSystemOptions

Optional debug

debug?: boolean

Optional diagnosticOptOut

diagnosticOptOut?: boolean

Optional diagnosticRecordingInterval

diagnosticRecordingInterval?: number

Optional disableCache

disableCache?: boolean

Optional eventsUri

eventsUri?: string

Optional flushInterval

flushInterval?: number

Optional hooks

hooks?: Hook[]

Optional initialConnectionMode

initialConnectionMode?: ConnectionMode

Sets the mode to use for connections when the SDK is initialized.

Remarks

Possible values are offline, streaming, or polling. See ConnectionMode for more information.

Default Value

streaming.

Optional inspectors

inspectors?: LDInspection[]

Optional logger

logger?: LDLogger

Optional maxCachedContexts

maxCachedContexts?: number

Optional payloadFilterKey

payloadFilterKey?: string

Optional plugins

plugins?: LDPlugin[]

A list of plugins to be used with the SDK.

Plugin support is currently experimental and subject to change.

Optional pollInterval

pollInterval?: number

Optional privateAttributes

privateAttributes?: string[]

Optional Readonly runInBackground

runInBackground?: boolean

Some platforms (windows, web, mac, linux) can continue executing code in the background.

Defaults to false.

Optional sendEvents

sendEvents?: boolean

Optional Readonly storage

storage?: RNStorage

Custom storage implementation.

Typical SDK usage will not involve using customized storage.

Storage is used used for caching flag values for context as well as persisting generated identifiers. Storage could be used for additional features in the future.

Defaults to @react-native-async-storage/async-storage see their documentation for more information.

Remarks

If there is an issue with the storage implementation, then generated keys and context caches may not be persisted. This will cause the SDK to generate new keys and context caches on every startup.

Optional streamInitialReconnectDelay

streamInitialReconnectDelay?: number

Optional streamUri

streamUri?: string

Optional useReport

useReport?: boolean

Optional withReasons

withReasons?: boolean

Optional wrapperName

wrapperName?: string

Optional wrapperVersion

wrapperVersion?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc