openfeature

Published 0.5.0 API. For corrected targeting, tenant-context, and custom-provider usage, read the maintained version boundary. Unreleased fixes are not included in these signatures.

Interfaces

OpenFeatureBooleanProvider

Defined in: src/openfeature.ts:31

Properties

metadata

metadata: {
  name: string;
};

Defined in: src/openfeature.ts:32

name

name: string;

Methods

resolveBooleanEvaluation()

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

Defined in: src/openfeature.ts:33

Parameters

Parameter	Type
flagKey	string
defaultValue	boolean
context	OpenFeatureEvaluationContext

Returns

Promise<OpenFeatureBooleanResolutionDetails>

---

OpenFeatureBooleanProviderOptions

Defined in: src/openfeature.ts:10

Properties

name?

optional name?: string;

Defined in: src/openfeature.ts:11

---

OpenFeatureBooleanResolutionDetails

Defined in: src/openfeature.ts:22

Properties

errorCode?

optional errorCode?: string;

Defined in: src/openfeature.ts:26

errorMessage?

optional errorMessage?: string;

Defined in: src/openfeature.ts:27

flagMetadata

flagMetadata: Record<string, unknown>;

Defined in: src/openfeature.ts:28

reason

reason: string;

Defined in: src/openfeature.ts:24

value

value: boolean;

Defined in: src/openfeature.ts:23

variant?

optional variant?: string;

Defined in: src/openfeature.ts:25

---

OpenFeatureEvaluationContext

Defined in: src/openfeature.ts:14

Indexable

[key: string]: unknown

Properties

environment?

optional environment?: unknown;

Defined in: src/openfeature.ts:18

targetingKey?

optional targetingKey?: unknown;

Defined in: src/openfeature.ts:15

tenantId?

optional tenantId?: unknown;

Defined in: src/openfeature.ts:17

userId?

optional userId?: unknown;

Defined in: src/openfeature.ts:16

Functions

createOpenFeatureBooleanProvider()

function createOpenFeatureBooleanProvider(service, options?): OpenFeatureBooleanProvider;

Defined in: src/openfeature.ts:40

Parameters

Parameter	Type
service	FeatureFlagService
options	OpenFeatureBooleanProviderOptions

Returns

OpenFeatureBooleanProvider