Class FeatureConfig

constructor

• new FeatureConfig(
      featureName: string,
      config: FeatureRemoteConfig,
  ): FeatureConfig

  Creates a new FeatureConfig instance.

  Parameters

  • featureName: string

    Unique name for the feature or application being configured

  • config: FeatureRemoteConfig

    The raw remote configuration data containing planned releases

  Returns FeatureConfig

featureName

getActiveRelease

• getActiveRelease(): FeatureReleasePlan | null

  Finds the currently active release plan based on current time.

  Returns FeatureReleasePlan | null

  The active release plan, or null if no downtime is currently active

  Example

  const currentDowntime = config.getActiveRelease();
  if (currentDowntime) {
    console.log(`Downtime ends at: ${currentDowntime.downtimeEndAt}`);
  }
  Copy

getAllReleases

• getAllReleases(): FeatureReleasePlan[]

  Retrieves all planned release configurations.

  Returns FeatureReleasePlan[]

  Array of release plans

getConfigs

• getConfigs(): FeatureRemoteConfig

  Retrieves the raw configuration data.

  Returns FeatureRemoteConfig

  The feature remote configuration

getCurrentVersion

• getCurrentVersion(): string | null

  Retrieves the current version string from configuration.

  Returns string | null

  The version string, or null if not set

getIsGlobal

• getIsGlobal(): boolean
  Internal

  Checks if the configuration data came from the global workspace.

  Returns boolean

  True if global fallback data

getIsInMaintenance

• getIsInMaintenance(scope?: string, strategy?: MaintenanceStrategy): boolean

  Determines if the feature is currently in a maintenance window for the given scope.

  Parameters

  • scope: string = '*'

    The application scope to check (e.g., 'web', 'ios', or '*' for any)

  • strategy: MaintenanceStrategy = 'auto'

    Maintenance strategy to apply ('auto', 'always', or 'none')

  Returns boolean

  True if currently in maintenance

  Example

  const isMaintenance = config.getIsInMaintenance('ios', 'auto');
  Copy

getNextActiveRelease

• getNextActiveRelease(): FeatureReleasePlan | null

  Finds the next scheduled release plan in the future.

  Returns FeatureReleasePlan | null

  The next upcoming release plan, or null if none are scheduled

  Example

  const nextDowntime = config.getNextActiveRelease();
  if (nextDowntime) {
    notifyUsers(`Planned maintenance on ${nextDowntime.downtimeStartAt}`);
  }
  Copy