Control.Flipper

Documentation

enabled :: HasFeatureFlags m => FeatureName -> m Bool

The enabled function returns a Bool indicating if the queried feature is active.

When the queried FeatureName does not exists, enabled returns False.

enabledFor :: (HasFeatureFlags m, HasActorId a) => FeatureName -> a -> m Bool

The enabledFor function returns a Bool indicating if the queried feature is active for the given enitty.

If the queried FeatureName does not exists, enabledFor returns False.

enable :: ModifiesFeatureFlags m => FeatureName -> m ()

The enable function activates a feature globally.

When the FeatureName does not exist, it is created and set to active.

enableFor :: (ModifiesFeatureFlags m, HasActorId a) => FeatureName -> a -> m ()

The enableFor function activates a feature for a single actor.

If the FeatureName does not exist in the store, it is created and set to active only for the given actor.

enableForPercentage :: ModifiesFeatureFlags m => FeatureName -> Percentage -> m ()

The enableForPercentage function activates a feature for a percentage of actors.

If the FeatureName does not exist in the store, it is created and set to active only for the specified percentage.

disable :: ModifiesFeatureFlags m => FeatureName -> m ()

The disable function deactivates a feature globally.

When the FeatureName does not exist, it is created and set to inactive.

toggle :: ModifiesFeatureFlags m => FeatureName -> m ()

The toggle function flips the current state of a feature globally.

When the FeatureName does not exist, it is created and set to True.

whenEnabled :: HasFeatureFlags m => FeatureName -> m () -> m ()

The whenEnabled function calls the supplied function, 'm ()', when the given FeatureName is enabled.

When the feature specified by FeatureName is disabled, 'm ()' is not evaluated.

whenEnabledFor :: (HasFeatureFlags m, HasActorId a) => FeatureName -> a -> m () -> m ()

The whenEnabledFor function calls the supplied function, 'm ()', when the given FeatureName is enabled for the given actor.

When the feature specified by FeatureName is disabled for the given actor, 'm ()' is not evaluated.

module Control.Flipper.Types