chore(docs): Generated References (#5743)

Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
@@ -12,11 +12,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new FlagRouter**(flags)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -46,7 +46,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### isFeatureEnabled
#### isFeatureEnabled
`**isFeatureEnabled**(flag): boolean`
@@ -58,7 +58,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 +72,7 @@ An example of a nested flag is workflows. To use it, you would do:
}
]} />
#### Returns
##### Returns
`boolean`
@@ -90,11 +90,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 +112,7 @@ ___
___
### setFlag
#### setFlag
`**setFlag**(key, value): void`
@@ -122,7 +122,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 +145,7 @@ These shapes are used for top-level and nested flags respectively, as explained
}
]} />
#### Returns
##### Returns
`void`