@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?
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
Provider.domainScopedevents?
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
Provider.eventshooks?
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
Provider.hooksmetadata
metadata: {
name: string;
};Defined in: src/openfeature.ts:34
name
name: string;Overrides
Provider.metadatarunsOn?
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
Provider.runsOnstatus?
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
Provider.statusMethods
initialize()?
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
| Parameter | Type | Description |
|---|---|---|
context? | EvaluationContext | the global evaluation context |
domain? | string | the bound domain, if any |
Returns
Promise<void>
Inherited from
Provider.initializeonClose()?
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
Provider.onCloseresolveBooleanEvaluation()
resolveBooleanEvaluation(
flagKey,
defaultValue,
context): Promise<OpenFeatureBooleanResolutionDetails>;Defined in: src/openfeature.ts:35
Resolve a boolean flag and its evaluation details.
Parameters
| Parameter | Type |
|---|---|
flagKey | string |
defaultValue | boolean |
context | OpenFeatureEvaluationContext |
Returns
Promise<OpenFeatureBooleanResolutionDetails>
Overrides
Provider.resolveBooleanEvaluationresolveNumberEvaluation()
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
| Parameter | Type |
|---|---|
flagKey | string |
defaultValue | number |
context | EvaluationContext |
logger | Logger |
Returns
Promise<ResolutionDetails<number>>
Inherited from
Provider.resolveNumberEvaluationresolveObjectEvaluation()
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
| Parameter | Type |
|---|---|
flagKey | string |
defaultValue | T |
context | EvaluationContext |
logger | Logger |
Returns
Promise<ResolutionDetails<T>>
Inherited from
Provider.resolveObjectEvaluationresolveStringEvaluation()
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
| Parameter | Type |
|---|---|
flagKey | string |
defaultValue | string |
context | EvaluationContext |
logger | Logger |
Returns
Promise<ResolutionDetails<string>>
Inherited from
Provider.resolveStringEvaluationtrack()?
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
| Parameter | Type | Description |
|---|---|---|
trackingEventName | string | - |
context | EvaluationContext | - |
trackingEventDetails | TrackingEventDetails | - |
Returns
void
Inherited from
Provider.trackOpenFeatureBooleanProviderOptions
Defined in: src/openfeature.ts:16
Properties
name?
optional name?: string;Defined in: src/openfeature.ts:17
OpenFeatureBooleanResolutionDetails
Defined in: src/openfeature.ts:28
Extends
ResolutionDetails<boolean>
Properties
errorCode?
optional errorCode?: ErrorCode;Defined in: node_modules/@openfeature/core/dist/types.d.ts:101
Inherited from
ResolutionDetails.errorCodeerrorMessage?
optional errorMessage?: string;Defined in: node_modules/@openfeature/core/dist/types.d.ts:102
Inherited from
ResolutionDetails.errorMessageflagMetadata
flagMetadata: FlagMetadata;Defined in: src/openfeature.ts:30
Overrides
ResolutionDetails.flagMetadatareason
reason: string;Defined in: src/openfeature.ts:29
Overrides
ResolutionDetails.reasonvalue
value: boolean;Defined in: node_modules/@openfeature/core/dist/types.d.ts:97
Inherited from
ResolutionDetails.valuevariant?
optional variant?: string;Defined in: node_modules/@openfeature/core/dist/types.d.ts:98
Inherited from
ResolutionDetails.variantOpenFeatureEvaluationContext
Defined in: src/openfeature.ts:20
Indexable
[key: string]: unknownProperties
environment?
optional environment?: unknown;Defined in: src/openfeature.ts:24
targetingKey?
optional targetingKey?: unknown;Defined in: src/openfeature.ts:21
tenantId?
optional tenantId?: unknown;Defined in: src/openfeature.ts:23
userId?
optional userId?: unknown;Defined in: src/openfeature.ts:22
Functions
createOpenFeatureBooleanProvider()
function createOpenFeatureBooleanProvider(service, options?): OpenFeatureBooleanProvider;Defined in: src/openfeature.ts:42
Parameters
| Parameter | Type |
|---|---|
service | Pick<FeatureFlagService, "evaluateBoolean"> |
options | OpenFeatureBooleanProviderOptions |