testing

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.

Classes

TestFeatureFlagController

Defined in: src/testing/test-feature-flag.module.ts:71

Type Parameters

Type Parameter	Default type
TFlags extends FlagRegistry	FlagRegistry

Constructors

Constructor

new TestFeatureFlagController<TFlags>(defaults, overrides?): TestFeatureFlagController<TFlags>;

Defined in: src/testing/test-feature-flag.module.ts:75

Parameters

Parameter	Type
defaults	Record<string, boolean>
overrides	Partial<Record<FlagKey<TFlags>, boolean>>

Returns

TestFeatureFlagController<TFlags>

Methods

evaluateAll()

evaluateAll(): Record<string, boolean>;

Defined in: src/testing/test-feature-flag.module.ts:95

Returns

Record<string, boolean>

findAll()

findAll(): FeatureFlagWithOverrides[];

Defined in: src/testing/test-feature-flag.module.ts:122

Returns

FeatureFlagWithOverrides[]

findFlag()

findFlag(key): FeatureFlagWithOverrides;

Defined in: src/testing/test-feature-flag.module.ts:114

Parameters

Parameter	Type
key	string

Returns

FeatureFlagWithOverrides

getDetails()

getDetails(key, options?): BooleanEvaluationDetails;

Defined in: src/testing/test-feature-flag.module.ts:99

Parameters

Parameter	Type
key	string
options	EvaluateBooleanOptions

Returns

BooleanEvaluationDetails

isEnabled()

isEnabled(key, options?): boolean;

Defined in: src/testing/test-feature-flag.module.ts:91

Parameters

Parameter	Type
key	string
options	EvaluateBooleanOptions

Returns

boolean

reset()

reset(): void;

Defined in: src/testing/test-feature-flag.module.ts:87

Returns

void

set()

set<K>(key, value): void;

Defined in: src/testing/test-feature-flag.module.ts:83

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
key	K
value	boolean

Returns

void

---

TestFeatureFlagModule

Defined in: src/testing/test-feature-flag.module.ts:31

Constructors

Constructor

new TestFeatureFlagModule(): TestFeatureFlagModule;

Returns

TestFeatureFlagModule

Methods

register()

static register(flags?): DynamicModule;

Defined in: src/testing/test-feature-flag.module.ts:32

Parameters

Parameter	Type
flags?	Record<string, boolean>

Returns

DynamicModule

registerRegistry()

static registerRegistry<TFlags>(flags, options?): DynamicModule;

Defined in: src/testing/test-feature-flag.module.ts:37

Type Parameters

Type Parameter
TFlags extends FlagRegistry

Parameters

Parameter	Type
flags	TFlags
options	TestFeatureFlagRegistryOptions<TFlags>

Returns

DynamicModule

Interfaces

TestFeatureFlagRegistryOptions

Defined in: src/testing/test-feature-flag.module.ts:67

Type Parameters

Type Parameter
TFlags extends FlagRegistry

Properties

overrides?

optional overrides?: Partial<Record<Extract<keyof TFlags, string>, boolean>>;

Defined in: src/testing/test-feature-flag.module.ts:68