ProviderConfig | LaunchDarkly React SDK (2.20.2)

Configuration object used to initialise LaunchDarkly's JS client.

Hierarchy

ProviderConfig

Index

Properties

clientSideID

clientSideID: string

Your project and environment specific client side ID. You can find this in your LaunchDarkly portal under Account settings. This is the only mandatory property required to use the React SDK.

Optional deferInitialization

deferInitialization: undefined | false | true

If set to true, the ldClient will not be initialized until the user prop has been defined.

Optional flags

flags: LDFlagSet

If specified, launchdarkly-react-client-sdk will only request and listen to these flags. Otherwise, all flags will be requested and listened to.

Optional options

options: LDOptions

LaunchDarkly initialization options. These options are common between LaunchDarkly's JavaScript and React SDKs.

see: https://docs.launchdarkly.com/docs/js-sdk-reference#section-customizing-your-client

Optional reactOptions

reactOptions: LDReactOptions

Additional initialization options specific to the React SDK.

see: options

Optional user

user: LDUser

A LaunchDarkly user object. If unspecified, a new user with a random key will be created and used. This user's key will remain constant across browser sessions.

see: http://docs.launchdarkly.com/docs/js-sdk-reference#section-users