Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • FeatureManager

Index

Constructors

constructor

Properties

config

config: FeatureManagerConfig

features

features: Record<string, boolean | FeatureManagerSettings>

Methods

isOff

  • isOff(featureKey: string): boolean
  • Determine if a feature is turned off.

    Parameters

    • featureKey: string

      Key to represent the feature.

    Returns boolean

    True if the feature is off or the default is off.

isOn

  • isOn(featureKey: string): boolean
  • Determine if a feature is turned on.

    Parameters

    • featureKey: string

      Key to represent the feature.

    Returns boolean

    True if the feature is on or the default is on.

off

  • off(featureKey: string, settings?: FeatureManagerSettings): boolean | FeatureManagerSettings
  • Turn a feature off.

    Parameters

    • featureKey: string

      Key to represent the feature.

    • Optional settings: FeatureManagerSettings

    Returns boolean | FeatureManagerSettings

    false

on

  • on(featureKey: string, settings?: FeatureManagerSettings): boolean | FeatureManagerSettings
  • Turn a feature on.

    Parameters

    • featureKey: string

      Key to represent the feature.

    • Optional settings: FeatureManagerSettings

    Returns boolean | FeatureManagerSettings

    true

set

  • set(featureKey: string, value: boolean | FeatureManagerSettings): boolean | FeatureManagerSettings
  • Parameters

    • featureKey: string
    • value: boolean | FeatureManagerSettings

    Returns boolean | FeatureManagerSettings

settings

  • settings(featureKey: string): undefined | FeatureManagerSettings

Generated using TypeDoc