projectConfigManager

OpaqueConfigManager

projectConfigManager object to manage project configuration. You must provide an instance ofOpaqueConfigManager which could be created by factory functions such ascreatePollingProjectConfigManager orcreateStaticProjectConfigManager.

eventProcessoroptional

OpaqueEventProcessor

eventProcessor object to process events. You should provide an instance ofOpaqueEventProcessor which could be created by the factory functions such as -createForwardingEventProcessor orcreateBatchEventProcessor.

If this is not set, no events are dispatched.

odpManageroptional

OpaqueOdpManager

odpManager contains the logic supporting Real-time Audiences for Feature Experimentation-related features, including audience segments.

You should provide an instance ofOpaqueOdpManager which can be created by the factory functioncreateOdpManager.

vuidManageroptional

OpaqueVuidManager

vuidManager object is to managevuid.

You should provide an instance ofOpaqueVuidManager which could be created by the factory functioncreateVuidManager.

NodeJS environments do not have support forvuid. It is a client-side only function.

loggeroptional

OpaqueLogger

A logger implementation to log messages.

You should provide an instance ofOpaqueLogger which could be created by the factory functioncreateLogger.

errorNotifieroptional

OpaqueErrorNotifier

errorNotifier is used to get notified about errors in the SDK instance. An instance of an error notifier can be created using thecreateErrorNotifier factory function which takes aErrorHandler object as a parameter.

userProfileServiceoptional

UserProfileService

A user profile service. An object withlookup andsave methods.

userProfileServiceAsyncoptional

UserProfileServiceAsync

An async version of user profile service. An object withlookup andsave methods that return promises.

jsonSchemaValidatoroptional

{ validate(jsonObject: unknown): boolean; }

To perform JSON schema validation on datafiles. Validator must have avalidate method that returnsboolean value as result.

Skipping JSON schema validation enhances performance during initialization.

defaultDecideOptionsoptional

OptimizelyDecideOption[]

Array ofOptimizelyDecideOption enums.

When you construct the Optimizely client with this parameter, it sets default decide options which are applied to all the decide calls made during the lifetime of the Optimizely client. Also, you can pass options to individual decide methods (does not override defaults). SeeOptimizelyDecideOption.

disposableoptional

boolean

Make the instance disposable, which means all background processing is turned off (no datafile polling, no event batching) so that the instance can be garbage collected when all reference to it ceases to exist, even if theclose() method is not called. Without it, the SDK instance might not be garbage collected ifclose() method is not called.

This is particularly beneficial in situations where an instance of the SDK is created per request, and explicitly callingclose() on the instances are inconvenient or impossible (for example, server-side rendering, edge environments, and so on).

clientEngineoptional

string

clientEngine is a string that indicates the environment in which the SDK is being used. If not provided, default values indicating the Javascript environment is used.

This is useful when a wrapper client (For example, React SDK) is created around the SDK.

clientVersionoptional

string

clientVersion is a string that indicates the client version. If not provided, the version of the Javascript SDK is used by default.

sdkKey

string

The key associated with an environment in the project.

datafileoptional

string

The JSON string representing the project.

jsonSchemaValidatoroptional

object

To perform JSON schema validation on datafiles.

Skipping validation enhances performance during initialization

autoUpdateoptional

boolean

Whentrue, andsdkKey was provided, automatic updates are enabled on this instance. The default value isfalse.

updateIntervaloptional

number

When automatic updates are enabled, this controls the update interval. The unit is milliseconds. The minimum allowed value is 1000 (one second). The default value is 300000 milliseconds (five minutes).

urlTemplateoptional

string

A format string used to build the URL from which the SDK requests datafiles. Instances of%s are replaced with thesdkKey. When not provided, the SDK requests datafiles from the Optimizely CDN.

datafileAccessTokenoptional

string

A bearer token used to authenticate requests when fetching the secure environment and needs authorization.

cacheoptional

Store<string>

An optional cache interface used to persist the downloaded datafile. This can be helpful to avoid unnecessary network requests.

datafile

string

The JSON string representing the project.

jsonSchemaValidatoroptional

object

To perform JSON schema validation on datafiles.

Skipping validation enhances performance during initialization

eventDispatcheroptional

EventDispatcher

A custom event dispatcher used to send events. If not provided, the default dispatcher is used.

closingEventDispatcheroptional

EventDispatcher

A specialized custom dispatcher used to send any remaining events when the processor shuts down.

flushIntervaloptional

number

The time interval (in miliseconds) at which the event queue is automatically flushed. Default is 1000 milliseconds for browser and React Native and 30 seconds for NodeJS.

batchSizeoptional

number

The number of events to accumulate before sending them as a batch. Default is 10.

eventStoreoptional

Store<string>

A custom cache implementation to store events temporarily to track failed events to retry later on.

eventDispatcheroptional

EventDispatcher

A custom event dispatcher used to send events. If not provided, the default dispatcher is used.

*segmentsCacheoptional

Cache<string[]>

A custom cache implementation used to store fetched user segments locally. Helps avoid repeated API calls for the same user. If not provided, a default segments cache is used.

segmentsCacheSizeoptional

number

The maximum number of user segment entries to keep in the cache. Default is 1000.

segmentsCacheTimeoutoptional

number

The time (in milliseconds) before a cached segment entry expires. After this, the SDK re-fetches the segments. Default is 60000 milliseconds.

segmentsApiTimeoutoptional

number

The maximum time (in milliseconds) to wait for a response when calling the ODP Segments API. Default is 10000 milliseconds.

segmentManageroptional

OdpSegmentManager

A custom implementation of theOdpSegmentManager that handles how segments are fetched and managed. Override this for advanced use cases.

eventFlushIntervaloptional

number

How often (in miliseconds) to flush queued ODP events to the ODP server. Works similarly to batch processing in event handling.

eventBatchSizeoptional

number

Number of events to accumulate before triggering a flush to the server. Helps reduce the number of network calls.

eventApiTimeoutoptional

number

The maximum time (in milliseconds) to wait for the ODP Events API to respond. Controls timeout behavior for event dispatching.

eventManageroptional

OdpEventManager

A custom implementation of theOdpEventManager that manages how events are queued and dispatched. Useful for extending or overriding default behavior.

userAgentParseroptional

UserAgentParser

A utility to parse the user agent string, typically used to enrich event data with device or browser info.

vuidCacheoptional

Store<string>

A custom cache implementation used to store VUID locally.

enableVuidoptional

boolean

A flag to enable or disable VUID tracking.

If false (default behavior), the VUID is disabled, and any previously cached VUID data is cleared from the provided cache.

If true, the VUID is managed and used for tracking.