Skip to content

@nestarc/feature-flag/openfeature API reference ​

Create the Boolean evaluation provider with createOpenFeatureBooleanProvider. This subpath documents its evaluation context and resolution details; it is not a reference for other OpenFeature value types.

Browse all @nestarc/feature-flag import paths.

Published 0.6.0 API. For targeting, tenant-context, and custom-provider usage, read the agent guide and upgrade guidance. Signatures and source links describe this published release.

Interfaces ​

OpenFeatureBooleanProvider ​

Defined in: src/openfeature.ts:33

Extends ​

  • Provider

Properties ​

domainScoped? ​
ts
readonly optional domainScoped?: boolean;

Defined in: node_modules/@openfeature/core/dist/types.d.ts:495

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.

Inherited from ​
ts
Provider.domainScoped

events? ​
ts
optional events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;

Defined in: node_modules/@openfeature/core/dist/types.d.ts:507

An event emitter for ProviderEvents.

See ​

ProviderEvents

Inherited from ​
ts
Provider.events

hooks? ​
ts
readonly optional hooks?: Hook<Record<string, unknown>>[];

Defined in: node_modules/@openfeature/server-sdk/dist/types.d.ts:113

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.

Inherited from ​
ts
Provider.hooks

metadata ​
ts
metadata: {
  name: string;
};

Defined in: src/openfeature.ts:34

name ​
ts
name: string;
Overrides ​
ts
Provider.metadata

runsOn? ​
ts
readonly optional runsOn?: Paradigm;

Defined in: node_modules/@openfeature/core/dist/types.d.ts:490

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

Inherited from ​
ts
Provider.runsOn

status? ​
ts
readonly optional status?: ServerProviderStatus;

Defined in: node_modules/@openfeature/core/dist/types.d.ts:502

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.

Inherited from ​
ts
Provider.status

Methods ​

initialize()? ​
ts
optional initialize(context?, domain?): Promise<void>;

Defined in: node_modules/@openfeature/core/dist/types.d.ts:522

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 ​
ParameterTypeDescription
context?EvaluationContextthe global evaluation context
domain?stringthe bound domain, if any
Returns ​

Promise<void>

Inherited from ​
ts
Provider.initialize

onClose()? ​
ts
optional onClose(): Promise<void>;

Defined in: node_modules/@openfeature/core/dist/types.d.ts:512

A function used to shut down the provider. Called when this provider is replaced with a new one, or when the OpenFeature is shut down.

Returns ​

Promise<void>

Inherited from ​
ts
Provider.onClose

resolveBooleanEvaluation() ​
ts
resolveBooleanEvaluation(
   flagKey,
   defaultValue,
context): Promise<OpenFeatureBooleanResolutionDetails>;

Defined in: src/openfeature.ts:35

Resolve a boolean flag and its evaluation details.

Parameters ​
ParameterType
flagKeystring
defaultValueboolean
contextOpenFeatureEvaluationContext
Returns ​

Promise<OpenFeatureBooleanResolutionDetails>

Overrides ​
ts
Provider.resolveBooleanEvaluation

resolveNumberEvaluation() ​
ts
resolveNumberEvaluation(
   flagKey,
   defaultValue,
   context,
logger): Promise<ResolutionDetails<number>>;

Defined in: node_modules/@openfeature/server-sdk/dist/types.d.ts:125

Resolve a numeric flag and its evaluation details.

Parameters ​
ParameterType
flagKeystring
defaultValuenumber
contextEvaluationContext
loggerLogger
Returns ​

Promise<ResolutionDetails<number>>

Inherited from ​
ts
Provider.resolveNumberEvaluation

resolveObjectEvaluation() ​
ts
resolveObjectEvaluation<T>(
   flagKey,
   defaultValue,
   context,
logger): Promise<ResolutionDetails<T>>;

Defined in: node_modules/@openfeature/server-sdk/dist/types.d.ts:129

Resolve and parse an object flag and its evaluation details.

Type Parameters ​
Type Parameter
T extends JsonValue
Parameters ​
ParameterType
flagKeystring
defaultValueT
contextEvaluationContext
loggerLogger
Returns ​

Promise<ResolutionDetails<T>>

Inherited from ​
ts
Provider.resolveObjectEvaluation

resolveStringEvaluation() ​
ts
resolveStringEvaluation(
   flagKey,
   defaultValue,
   context,
logger): Promise<ResolutionDetails<string>>;

Defined in: node_modules/@openfeature/server-sdk/dist/types.d.ts:121

Resolve a string flag and its evaluation details.

Parameters ​
ParameterType
flagKeystring
defaultValuestring
contextEvaluationContext
loggerLogger
Returns ​

Promise<ResolutionDetails<string>>

Inherited from ​
ts
Provider.resolveStringEvaluation

track()? ​
ts
optional track(
   trackingEventName,
   context,
   trackingEventDetails): void;

Defined in: node_modules/@openfeature/core/dist/types.d.ts:529

Track a user action or application state, usually representing a business objective or outcome.

Parameters ​
ParameterTypeDescription
trackingEventNamestring-
contextEvaluationContext-
trackingEventDetailsTrackingEventDetails-
Returns ​

void

Inherited from ​
ts
Provider.track

OpenFeatureBooleanProviderOptions ​

Defined in: src/openfeature.ts:16

Properties ​

name? ​
ts
optional name?: string;

Defined in: src/openfeature.ts:17


OpenFeatureBooleanResolutionDetails ​

Defined in: src/openfeature.ts:28

Extends ​

  • ResolutionDetails<boolean>

Properties ​

errorCode? ​
ts
optional errorCode?: ErrorCode;

Defined in: node_modules/@openfeature/core/dist/types.d.ts:101

Inherited from ​
ts
ResolutionDetails.errorCode

errorMessage? ​
ts
optional errorMessage?: string;

Defined in: node_modules/@openfeature/core/dist/types.d.ts:102

Inherited from ​
ts
ResolutionDetails.errorMessage

flagMetadata ​
ts
flagMetadata: FlagMetadata;

Defined in: src/openfeature.ts:30

Overrides ​
ts
ResolutionDetails.flagMetadata

reason ​
ts
reason: string;

Defined in: src/openfeature.ts:29

Overrides ​
ts
ResolutionDetails.reason

value ​
ts
value: boolean;

Defined in: node_modules/@openfeature/core/dist/types.d.ts:97

Inherited from ​
ts
ResolutionDetails.value

variant? ​
ts
optional variant?: string;

Defined in: node_modules/@openfeature/core/dist/types.d.ts:98

Inherited from ​
ts
ResolutionDetails.variant

OpenFeatureEvaluationContext ​

Defined in: src/openfeature.ts:20

Indexable ​

ts
[key: string]: unknown

Properties ​

environment? ​
ts
optional environment?: unknown;

Defined in: src/openfeature.ts:24

targetingKey? ​
ts
optional targetingKey?: unknown;

Defined in: src/openfeature.ts:21

tenantId? ​
ts
optional tenantId?: unknown;

Defined in: src/openfeature.ts:23

userId? ​
ts
optional userId?: unknown;

Defined in: src/openfeature.ts:22

Functions ​

createOpenFeatureBooleanProvider() ​

ts
function createOpenFeatureBooleanProvider(service, options?): OpenFeatureBooleanProvider;

Defined in: src/openfeature.ts:42

Parameters ​

ParameterType
servicePick<FeatureFlagService, "evaluateBoolean">
optionsOpenFeatureBooleanProviderOptions

Returns ​

OpenFeatureBooleanProvider

Documentation site: MIT License. Check each package for its license.