Interface LDIdentifyOptions

Hierarchy

  • Omit<LDIdentifyOptions, "waitForNetworkResults">
    • LDIdentifyOptions

Properties

bootstrap?: unknown

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

Bootstrap data can be generated by server SDKs. When bootstrap data is provided the SDK the identification operation will complete without waiting for any values from LaunchDarkly and the variation calls can be used immediately.

If streaming is activated, either it is configured to always be used, or is activated via setStreaming, or via the addition of change handlers, then a streaming connection will subsequently be established.

For more information, see the SDK Reference Guide.

hash?: string
noTimeout?: boolean

When set to true, and timeout is not set, this indicates that the identify operation will not have any timeout. In typical usage, where an application awaits the promise, a timeout is important because identify can potentially take indefinite time depending on network conditions. If your application specifically does not block any operations pending the promise resolution, then you can use this opton to explicitly indicate that.

If you set this to true, and you do not set a timeout, and you block aspects of operation of your application, then those aspects can be blocked indefinitely. Generally this option will not be required.

timeout?: number

In seconds. Determines when the identify promise resolves if no flags have been returned from the network. If you use a large timeout and await it, then any network delays will cause your application to wait a long time before continuing execution.

Defaults to 5 seconds.

Generated using TypeDoc