Interface ExperimentConfig

Provides a analytics implementation for standard experiment events generated by the client (e.g. ExposureEvent).

If true, automatically tracks exposure events though the ExperimentAnalyticsProvider. If no analytics provider is set, this option does nothing.

This config only matters if you are using the amplitude analytics SDK integration initialized by calling Experiment.initializeWithAmplitudeAnalytics().

If true, the ExperimentClient will automatically fetch variants when the user's identity changes. The user's identity includes user_id, device_id and any user properties which are set, unset or clearAlled via a call to identify().

Note: Non-idempotent identify operations setOnce, add, append, and prepend are not counted towards the user identity changing.

Debug all assignment requests in the UI Debugger and log additional information to the console. This should be false for production builds.

Provides the ability to track exposure events through a 3rd party analytics implementation.

The default fallback variant for all ExperimentClient.variant calls.

Explicitly enable or disable calling fetch() on start():

• true: fetch will always be called on start.
• false: fetch will never be called on start.
• undefined: fetch will always be called on start.

The request timeout, in milliseconds, when fetching variants.

The interval to poll local evaluation flag configurations on start(). Only used if pollOnStart is true. Minimum 60000.

The domain to request flag configurations used in local evaluation from.

(Advanced) Use your own http client.

Initial values for flags. This is useful for bootstrapping the client with fallbacks for flag configs.

Initial values for variants. This is useful for bootstrapping the client with fallbacks and values evaluated from server-side rendering.

The name of the instance being initialized. Used for initializing separate instances of experiment or linking the experiment SDK to a specific instance of the amplitude analytics SDK.

Custom logger implementation. If not provided, a default ConsoleLogger will be used. The logger must implement the Logger interface with methods for error, warn, info, debug, and verbose.

The minimum log level to output. Messages below this level will be ignored. Supported levels: Disable, Error (default), Warn, Info, Debug, Verbose. If the deprecated debug flag is set to true, this will default to Debug.

Enable or disable local evaluation flag configuration polling on start().

Set to true to retry fetch requests in the background if the initial requests fails or times out.

The domain from which to request variants using remote evaluation.

The amplitude data center to fetch flags and variants from. If set, automatically sets the serverUrl and flagsServerUrl configurations.

Determines the primary source of variants and variants before falling back.

When set to true, the client will throw errors if requests fail for any reason (including timeouts, network errors, or server errors), rather than silently handling the error. This applies to both the initial fetch during start() and subsequent fetch() calls. Background retries will still be started if configured via retryFetchOnFailure.

When false (default), errors are handled silently and retries may occur in the background based on the retryFetchOnFailure configuration.

Sets a user provider that will inject identity information into the user for fetch() requests. The user provider will only set user fields in outgoing requests which are null or undefined.

See ExperimentUserProvider for more details