docs: TSDoc + reference of fulfillment service (#5761)

This commit is contained in:
Shahed Nasser
2023-11-29 11:58:08 +00:00
committed by GitHub
parent 8f25ed8a10
commit f802e2460f
1479 changed files with 30259 additions and 16135 deletions
@@ -10,13 +10,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [IFlagRouter](../interfaces/IFlagRouter.mdx)
## Constructors
#### constructor
## constructor
`**new FlagRouter**(flags)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -30,6 +28,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -44,9 +44,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### isFeatureEnabled
### isFeatureEnabled
`**isFeatureEnabled**(flag): boolean`
@@ -58,7 +60,7 @@ We use 1. for top-level feature flags and 2. for nested feature flags. Almost al
An example of a nested flag is workflows. To use it, you would do:
`isFeatureEnabled({ workflows: Workflows.CreateCart })`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -72,7 +74,7 @@ An example of a nested flag is workflows. To use it, you would do:
}
]} />
##### Returns
#### Returns
`boolean`
@@ -90,11 +92,11 @@ An example of a nested flag is workflows. To use it, you would do:
___
#### listFlags
### listFlags
`**listFlags**(): [FeatureFlagsResponse](../types/FeatureFlagsResponse.mdx)`
##### Returns
#### Returns
[FeatureFlagsResponse](../types/FeatureFlagsResponse.mdx)
@@ -112,7 +114,7 @@ ___
___
#### setFlag
### setFlag
`**setFlag**(key, value): void`
@@ -122,7 +124,7 @@ Flags take two shapes:
`setFlag("myFeatureFlag", { nestedFlag: true })`
These shapes are used for top-level and nested flags respectively, as explained in isFeatureEnabled.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -145,7 +147,7 @@ These shapes are used for top-level and nested flags respectively, as explained
}
]} />
##### Returns
#### Returns
`void`