Class FeatureFlags<FlagsList>

A light weight implementation of feature flags to conditionally enable experimental and legacy features.

Type Parameters

FlagsList extends Record<any, any>

Index

Constructors

Methods

enabled disabled has when

Constructors

constructor

new FeatureFlags<FlagsList extends Record<any, any>>(
flags: FlagsList | (() => FlagsList),
): FeatureFlags<FlagsList>
Creates a new FeatureFlags instance
Type Parameters
- FlagsList extends Record<any, any>
Parameters
- flags: FlagsList | (() => FlagsList)
  Either a static flags object or a factory function
Returns FeatureFlags<FlagsList>
- Defined in src/feature_flags.ts:30

Methods

enabled

enabled<Feature extends string | number | symbol | string & {}>(
feature: Feature,
): boolean
Checks if a feature is enabled
Type Parameters
- Feature extends string | number | symbol | string & {}
Parameters
- feature: Feature
  The feature name to check
Returns boolean
boolean - True if the feature is enabled
- Defined in src/feature_flags.ts:44

disabled

disabled<Feature extends string | number | symbol | string & {}>(
feature: Feature,
): boolean
Checks if a feature is disabled
Type Parameters
- Feature extends string | number | symbol | string & {}
Parameters
- feature: Feature
  The feature name to check
Returns boolean
boolean - True if the feature is disabled
- Defined in src/feature_flags.ts:55

has

has<Feature extends string | number | symbol | string & {}>(
feature: Feature,
): boolean
Checks if a feature exists in the flags
Type Parameters
- Feature extends string | number | symbol | string & {}
Parameters
- feature: Feature
  The feature name to check
Returns boolean
boolean - True if the feature exists
- Defined in src/feature_flags.ts:66

when

when<
    Feature extends string
    | number
    | symbol
    | string & {},
    EnabledResult,
    DisabledResult,
>(
    feature: Feature,
    enabledCallback: () => EnabledResult,
    disabledCallback?: () => DisabledResult,
): [never] extends DisabledResult
    ? undefined | EnabledResult
    : EnabledResult | DisabledResult
Conditionally executes callbacks based on feature flag state
Type Parameters
- Feature extends string | number | symbol | string & {}
- EnabledResult
- DisabledResult
Parameters
- feature: Feature
  The feature name to check
- enabledCallback: () => EnabledResult
  Callback to execute when feature is enabled
- OptionaldisabledCallback: () => DisabledResult
  Optional callback to execute when feature is disabled
Returns [never] extends DisabledResult
? undefined | EnabledResult
: EnabledResult | DisabledResult
The result of the executed callback
- Defined in src/feature_flags.ts:79