Class LocalEvaluationClient

Experiment client for evaluating variants for a user locally.

Hierarchy

LocalEvaluationClient

Index

Constructors

Properties

cache cohortStorage

Methods

evaluate evaluateV2 start stop

Constructors

constructor

new LocalEvaluationClient(apiKey: string, config?: LocalEvaluationConfig, flagConfigCache?: FlagConfigCache, httpClient?: HttpClient, streamEventSourceFactory?: StreamEventSourceFactory): LocalEvaluationClient
Parameters
- apiKey: string
- Optional config: LocalEvaluationConfig
- Optional flagConfigCache: FlagConfigCache
- httpClient: HttpClient = ...
- streamEventSourceFactory: StreamEventSourceFactory = ...
Returns LocalEvaluationClient

Properties

`Readonly` cache

cache: InMemoryFlagConfigCache

Directly access the client's flag config cache.

Used for directly manipulating the flag configs used for evaluation.

`Readonly` cohortStorage

cohortStorage: InMemoryCohortStorage

Methods

evaluate

evaluate(user: ExperimentUser, flagKeys?: string[]): Promise<Variants>
Locally evaluates flag variants for a user.

This function will only evaluate flags for the keys specified in the flagKeys argument. If flagKeys is missing, all flags in the FlagConfigCache will be evaluated.

Returns
The evaluated variants

Deprecated
use evaluateV2 instead
Parameters
- user: ExperimentUser
  
  The user to evaluate
- Optional flagKeys: string[]
  
  The flags to evaluate with the user. If empty, all flags from the flag cache are evaluated.
Returns Promise<Variants>

evaluateV2

evaluateV2(user: ExperimentUser, flagKeys?: string[]): Record<string, Variant>
Locally evaluate varints for a user.

This function will only evaluate flags for the keys specified in the flagKeys argument. If flagKeys is missing, all flags in the FlagConfigCache will be evaluated.

Unlike evaluate, this function returns a default variant object if the flag or experiment was evaluated, but the user was not assigned a variant (i.e. 'off').

Returns
The evaluated variants
Parameters
- user: ExperimentUser
  
  The user to evaluate
- Optional flagKeys: string[]
  
  The flags to evaluate with the user. If empty, all flags from the flag cache are evaluated.
Returns Record<string, Variant>

start

start(): Promise<void>
Fetch initial flag configurations and start polling for updates.

You must call this function to begin polling for flag config updates. The promise returned by this function is resolved when the initial call to fetch the flag configuration completes.

Calling this function while the poller is already running does nothing.

Returns Promise<void>

stop

stop(): void
Stop polling for flag configurations.

Calling this function while the poller is not running will do nothing.

Returns void