Initialization options for the LaunchDarkly browser SDK.


  • LDOptionsBase
    • LDOptions


allAttributesPrivate?: boolean

Whether all context attributes (except the context key) should be marked as private, and not sent to LaunchDarkly in analytics events.

By default, this is false.

application?: {
    id?: string;
    version?: string;

Information about the application where the LaunchDarkly SDK is running.

Type declaration

  • Optional id?: string

    A unique identifier representing the application where the LaunchDarkly SDK is running.

    This can be specified as any string value as long as it only uses the following characters: ASCII letters, ASCII digits, period, hyphen, underscore. A string containing any other characters will be ignored.

    Example: authentication-service

  • Optional version?: string

    A unique identifier representing the version of the application where the LaunchDarkly SDK is running.

    This can be specified as any string value as long as it only uses the following characters: ASCII letters, ASCII digits, period, hyphen, underscore. A string containing any other characters will be ignored.

    Example: 1.0.0 (standard version string) or abcdef (sha prefix)

baseUrl?: string

The base URL for the LaunchDarkly server.

Most users should use the default value.

bootstrap?: "localStorage" | LDFlagSet

The initial set of flags to use until the remote set is retrieved.

If "localStorage" is specified, the flags will be saved and retrieved from browser local storage. Alternatively, an LDFlagSet can be specified which will be used as the initial source of flag values. In the latter case, the flag values will be available via variation immediately after calling initialize() (normally they would not be available until the client signals that it is ready).

For more information, see the SDK Reference Guide.

diagnosticOptOut?: boolean

Set to true to opt out of sending diagnostics data.

Unless diagnosticOptOut is set to true, the client will send some diagnostics data to the LaunchDarkly servers in order to assist in the development of future SDK improvements. These diagnostics consist of an initial payload containing some details of SDK in use, the SDK's configuration, and the platform the SDK is being run on, as well as payloads sent periodically with information on irregular occurrences such as dropped events.

diagnosticRecordingInterval?: number

The interval at which periodic diagnostic data is sent, in milliseconds.

The default is 900000 (every 15 minutes) and the minimum value is 6000. See diagnosticOptOut for more information on the diagnostics data being sent.

disableSyncEventPost?: boolean

If set to true, this prevents the SDK from trying to use a synchronous HTTP request to deliver analytics events if the page is being closed. Not all browsers allow such requests; the SDK normally tries to avoid making them if not allowed, by using browser detection, but sometimes browser detection may not work so if you are seeing errors like "synchronous XHR request during page dismissal", you may want to set this option. Since currently the SDK does not have a better way to deliver events in this scenario, some events may be lost.

evaluationReasons?: boolean

Whether LaunchDarkly should provide additional information about how flag values were calculated.

The additional information will then be available through the client's variationDetail method. Since this increases the size of network requests, such information is not sent unless you set this option to true.

eventCapacity?: number

The capacity of the analytics events queue.

The client buffers up to this many events in memory before flushing. If the capacity is exceeded before the queue is flushed, events will be discarded. Increasing the capacity means that events are less likely to be discarded, at the cost of consuming more memory. Note that in regular usage flag evaluations do not produce individual events, only summary counts, so you only need a large capacity if you are generating a large number of click, pageview, or identify events (or if you are using the event debugger).

The default value is 100.

eventUrlTransformer?: ((url: string) => string)

Type declaration

    • (url: string): string
    • A function which, if present, can change the URL in analytics events to something other than the actual browser URL. It will be called with the current browser URL as a parameter, and returns the value that should be stored in the event's url property.


      • url: string

      Returns string

eventsUrl?: string

The base URL for the LaunchDarkly events server.

Most users should use the default value.

fetchGoals?: boolean

Whether the client should make a request to LaunchDarkly for Experimentation metrics (goals).

This is true by default, meaning that this request will be made on every page load. Set it to false if you are not using Experimentation and want to skip the request.

flushInterval?: number

The interval in between flushes of the analytics events queue, in milliseconds.

The default value is 2000ms.

hash?: string

The signed context key for Secure Mode.

For more information, see the JavaScript SDK Reference Guide on Secure mode.

inspectors?: LDInspection[]

Inspectors can be used for collecting information for monitoring, analytics, and debugging.

logger?: LDLogger

An object that will perform logging for the client.

If not specified, the default is to use basicLogger.

privateAttributes?: string[]

Specifies a list of attribute names (either built-in or custom) which should be marked as private, and not sent to LaunchDarkly in analytics events. You can also specify this on a per-context basis with privateAttributes.

Any contexts sent to LaunchDarkly with this configuration active will have attributes with these names removed in analytic events. This is in addition to any attributes that were marked as private for an individual context with privateAttributes. Setting allAttributesPrivate to true overrides this.

If and only if a parameter starts with a slash, it is interpreted as a slash-delimited path that can denote a nested property within a JSON object. For instance, "/address/street" means that if there is an attribute called "address" that is a JSON object, and one of the object's properties is "street", the "street" property will be redacted from the analytics data but other properties within "address" will still be sent. This syntax also uses the JSON Pointer convention of escaping a literal slash character as "1" and a tilde as "0".

requestHeaderTransform?: ((headers: Map<string, string>) => Map<string, string>)

Type declaration

    • (headers: Map<string, string>): Map<string, string>
    • A transform function for dynamic configuration of HTTP headers.

      This method will run last in the header generation sequence, so the function should have all system generated headers in case those also need to be modified.


      • headers: Map<string, string>

      Returns Map<string, string>

sendEvents?: boolean

Whether to send analytics events back to LaunchDarkly. By default, this is true.

sendEventsOnlyForVariation?: boolean

Whether analytics events should be sent only when you call variation (true), or also when you call allFlags (false).

By default, this is false (events will be sent in both cases).

sendLDHeaders?: boolean

Whether or not to include custom HTTP headers when requesting flags from LaunchDarkly.

These are used to send metadata about the SDK (such as the version). They are also used to send the and application.version set in the options.

This defaults to true (custom headers will be sent). One reason you might want to set it to false is that the presence of custom headers causes browsers to make an extra OPTIONS request (a CORS preflight check) before each flag request, which could affect performance.

streamReconnectDelay?: number

How long (in milliseconds) to wait after a failure of the stream connection before trying to reconnect.

This only applies if streaming has been enabled by setting streaming to true or subscribing to "change" events. The default is 1000ms.

streamUrl?: string

The base URL for the LaunchDarkly streaming server.

Most users should use the default value.

streaming?: boolean

Whether or not to open a streaming connection to LaunchDarkly for live flag updates.

If this is true, the client will always attempt to maintain a streaming connection; if false, it never will. If you leave the value undefined (the default), the client will open a streaming connection if you subscribe to "change" or "change:flag-key" events (see on).

This is equivalent to calling client.setStreaming() with the same value.

useReport?: boolean

Whether or not to use the REPORT verb to fetch flag settings.

If this is true, flag settings will be fetched with a REPORT request including a JSON entity body with the context object.

Otherwise (by default) a GET request will be issued with the context passed as a base64 URL-encoded path parameter.

Do not use unless advised by LaunchDarkly.

wrapperName?: string

For use by wrapper libraries to set an identifying name for the wrapper being used.

This will be sent as diagnostic information to the LaunchDarkly servers to allow recording metrics on the usage of these wrapper libraries.

wrapperVersion?: string

For use by wrapper libraries to set version to be included alongside wrapperName.

If wrapperName is unset, this field will be ignored.

Generated using TypeDoc