is_enabled.env_var_feature_flag: Checks if the given environment variable feature flag is...

View source: R/feature_flag-env_var.R

is_enabled.env_var_feature_flagR Documentation

Checks if the given environment variable feature flag is enabled

Description

Checks if the given environment variable feature flag is enabled

Usage

## S3 method for class 'env_var_feature_flag'
is_enabled(feature_flag)

Arguments

feature_flag

Flag to be checked whether it is enabled

Value

TRUE if the environment variable is set to 'true'

Examples

{
  flag <- create_env_var_feature_flag("FEATURE_X")

  withr::with_envvar(new = list(FEATURE_X = "true"), {
    is_enabled(flag) # Returns TRUE
  })

  is_enabled(flag) # Returns FALSE by default
}

featureflag documentation built on April 4, 2025, 5:45 a.m.