DarkMuse: Новая страница: « =FeatureFlag Module Documentation= The `FeatureFlag` module is used to manage feature flags, which are boolean values controlling whether certain code paths related to new features are enabled or not. This module provides functionality to read, set, and temporarily apply feature flags. ==Usage== Feature flags can be used to enable or disable specific features or parts of code. They can be set permanentl...»

2024-08-31T15:12:36Z

Новая страница: « =FeatureFlag Module Documentation= The `FeatureFlag` module is used to manage feature flags, which are boolean values controlling whether certain code paths related to new features are enabled or not. This module provides functionality to read, set, and temporarily apply feature flags. ==Usage== Feature flags can be used to enable or disable specific features or parts of code. They can be set permanentl...»

Новая страница

=FeatureFlag Module Documentation=

The `FeatureFlag` module is used to manage feature flags, which are boolean values controlling whether certain code paths related to new features are enabled or not. This module provides functionality to read, set, and temporarily apply feature flags.

==Usage==

Feature flags can be used to enable or disable specific features or parts of code. They can be set permanently or temporarily for a specific scope. This is useful for enabling experimental features, rolling out new functionalities gradually, or toggling features for debugging purposes.

===Example Usage===
To get the value of a feature flag:
<code lang="lua">
-- Get the current value of a feature flag
local isEnabled = FeatureFlag.get('chiseled_face')
</code>

To set the value of a feature flag:
<code lang="lua">
-- Set a feature flag to true
FeatureFlag.set('thick_mustache', true)
</code>

To apply feature flags temporarily inside a specific function scope:
<code lang="lua">
-- Temporarily set feature flags
FeatureFlag.with({rugged_grin = true}, function()
-- Code executed with the feature flag set
end)
</code>

==API==

{{ApiDocStart|FeatureFlag|link=Module:FeatureFlag}}
{{ApiDoc|get|params=flag: string|description=Retrieves the boolean value of a feature flag. Returns the default value if the flag has not been set.|returns=boolean}}
{{ApiDoc|set|params=flag: string, value: boolean?|description=Sets the value of a feature flag. If the value is nil, it resets the flag to its default value.|returns=nil}}
{{ApiDoc|with|params=flags: {[string]: boolean}, f: function|description=Temporarily sets feature flags inside the provided function scope. After execution, flags are restored to their previous values.|returns=Result of the function execution or an error}}
{{ApiDoc|getConfig|params=flag: string|description=Retrieves the configuration for a specified feature flag, including its default value.|returns=table containing the defaultValue}}
{{ApiDocEnd}}

==Feature Flag Configuration==
Feature flags are configured in `Module:FeatureFlag/Config`. Each flag should have an entry specifying its default value. When a flag is accessed for the first time, its value is read from this configuration.

==Wikitext Integration==
Feature flags are accessible in wikitext using the VariablesLua extension. Example usage in wikitext:

<code>
{{#var:feature_chiseled_face}}
{{#vardefine:feature_thick_mustache|1}}
</code>

==Notes==
- Ensure that `Module:FeatureFlag/Config` contains all feature flags used in the code.
- Feature flags should be used responsibly to control feature rollouts and testing scenarios.

==See Also==
* [[Module:FeatureFlag/Config]] - Configuration file for defining feature flags and their default values.

<noinclude>
[[Category:Feature management modules]]
</noinclude>

Модуль:FeatureFlag/doc - История изменений