Interface LDClientInternalOptions

This is for internal use only.

Edge sdks use clientSideID to query feature stores. They also send analytics using this clientSideID. This is a hybrid behavior because they are based on js-server-common, but uses the clientSideID instead of the sdkKey for the above reasons. These internal options allow the edge sdks to use the EventSender to send analytics to the correct LD endpoints using the clientSideId.

Hierarchy

Properties

analyticsEventPath? credentialType dataSystemDefaults? diagnosticEventPath? getImplementationHooks getLegacyStorageKeys? highTimeoutThreshold? includeAuthorizationHeader? initialContext? requiresStart? trackEventModifier? userAgentHeaderName?

Properties

Optional analyticsEventPath

analyticsEventPath?: string

credentialType

credentialType: "clientSideId" | "mobileKey"

Optional dataSystemDefaults

dataSystemDefaults?: PlatformDataSystemDefaults

Optional diagnosticEventPath

diagnosticEventPath?: string

getImplementationHooks

getImplementationHooks: ((environmentMetadata) => Hook[])

Type declaration

Optional getLegacyStorageKeys

getLegacyStorageKeys?: (() => string[])

Type declaration

    • (): string[]

    • Returns string[]

Optional highTimeoutThreshold

highTimeoutThreshold?: number

In seconds. Log a warning if identifyTimeout is greater than this value.

Mobile - 15s. Browser - 5s. Server - 60s.

Optional includeAuthorizationHeader

includeAuthorizationHeader?: boolean

Optional initialContext

initialContext?: LDContext

The initial context to use when starting the client.

Optional requiresStart

requiresStart?: boolean

When true, the SDK requires start() to be called before identify(). Set this value to true to use the new initialization pattern.

Optional trackEventModifier

trackEventModifier?: ((event) => InputCustomEvent)

Type declaration

Optional userAgentHeaderName

userAgentHeaderName?: "user-agent" | "x-launchdarkly-user-agent"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc