Options for the waitForInitialization method.

Hierarchy

Properties

bootstrap?: unknown

Optional bootstrap data to use for the identify operation. If LDIdentifyOptions.bootstrap is provided, it will be ignored.

identifyOptions?: Omit<LDIdentifyOptions, "sheddable">

Optional identify options to use for the identify operation. See LDIdentifyOptions for more information.

Remarks

Since the first identify option should never be sheddable, we omit the sheddable option from the interface to avoid confusion.

timeout?: number

The timeout duration in seconds to wait for initialization before resolving the promise. If exceeded, the promise will resolve to a LDWaitForInitializationTimeout object.

If no options are specified on the waitForInitialization, the default timeout of 5 seconds will be used.

Using a high timeout, or no timeout, is not recommended because it could result in a long delay when conditions prevent successful initialization.

A value of 0 will cause the promise to resolve without waiting. In that scenario it would be more effective to not call waitForInitialization.

Default

5 seconds

Generated using TypeDoc