Interface Provider

Interface that providers must implement to resolve flag values for their particular backend or vendor.

Implementation for resolving all the required flag types must be defined.

interface Provider {
    domainScoped?: boolean;
    events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
    hooks?: Hook<Record<string, unknown>>[];
    metadata: ProviderMetadata;
    runsOn?: Paradigm;
    status?: ProviderStatus;
    initialize?(context?: EvaluationContext, domain?: string): Promise<void>;
    onClose?(): Promise<void>;
    resolveBooleanEvaluation(flagKey: string, defaultValue: boolean, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
    resolveNumberEvaluation(flagKey: string, defaultValue: number, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
    resolveObjectEvaluation<T>(flagKey: string, defaultValue: T, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
    resolveStringEvaluation(flagKey: string, defaultValue: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
    track?(trackingEventName: string, context: EvaluationContext, trackingEventDetails: TrackingEventDetails): void;
}

Hierarchy (view full)

Implemented by

Properties

domainScoped? events? hooks? metadata runsOn? status?

Methods

initialize? onClose? resolveBooleanEvaluation resolveNumberEvaluation resolveObjectEvaluation resolveStringEvaluation track?

Properties

Optional ReadonlydomainScoped

domainScoped?: boolean

When true, the provider maintains state specific to a single domain (such as a persistent cache) and the SDK will bind it to at most one domain.

Optionalevents

events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>

An event emitter for ProviderEvents.

See

ProviderEvents

Optional Readonlyhooks

hooks?: Hook<Record<string, unknown>>[]

A provider hook exposes a mechanism for provider authors to register hooks to tap into various stages of the flag evaluation lifecycle. These hooks can be used to perform side effects and mutate the context for purposes of the provider. Provider hooks are not configured or controlled by the application author.

Readonlymetadata

metadata: ProviderMetadata

Optional ReadonlyrunsOn

runsOn?: Paradigm

Represents where the provider is intended to be run. If defined, the SDK will enforce that the defined paradigm at runtime.

Optional Readonlystatus

status?: ProviderStatus

Deprecated

the SDK now maintains the provider's state; there's no need for providers to implement this field. Returns a representation of the current readiness of the provider.

Providers which do not implement this method are assumed to be ready immediately.

Methods

Optionalinitialize

  • initialize(context?, domain?): Promise<void>

  • A function used to setup the provider. Called by the SDK after the provider is set if the provider's status is NOT_READY. When the returned promise resolves, the SDK fires the ProviderEvents.Ready event. If the returned promise rejects, the SDK fires the ProviderEvents.Error event. Use this function to perform any context-dependent setup within the provider.

    Parameters

    • Optionalcontext: EvaluationContext

      the global evaluation context

    • Optionaldomain: string

      the bound domain, if any

    Returns Promise<void>

OptionalonClose

resolveBooleanEvaluation

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Optionaltrack

Settings

Member Visibility

On This Page

Properties
Methods