asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/interfaces/IStockLocationService.mdx
+34 -34
View File
@@ -10,16 +10,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### \_\_joinerConfig
**__joinerConfig**(): [`ModuleJoinerConfig`](../types/ModuleJoinerConfig.mdx)
`**__joinerConfig**(): [ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)`
#### Returns
[`ModuleJoinerConfig`](../types/ModuleJoinerConfig.mdx)
[ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)
<ParameterTypes parameters={[
{
"name": "ModuleJoinerConfig",
"type": "[`Omit`](../types/Omit.mdx)<[`JoinerServiceConfig`](JoinerServiceConfig.mdx), ``\"serviceName\"`` \\| ``\"primaryKeys\"`` \\| ``\"relationships\"`` \\| ``\"extends\"``\\> & { `databaseConfig?`: { `extraFields?`: Record<`string`, { `defaultValue?`: `string` ; `nullable?`: `boolean` ; `options?`: Record<`string`, `unknown`\\> ; `type`: ``\"date\"`` \\| ``\"time\"`` \\| ``\"datetime\"`` \\| ``\"bigint\"`` \\| ``\"blob\"`` \\| ``\"uint8array\"`` \\| ``\"array\"`` \\| ``\"enumArray\"`` \\| ``\"enum\"`` \\| ``\"json\"`` \\| ``\"integer\"`` \\| ``\"smallint\"`` \\| ``\"tinyint\"`` \\| ``\"mediumint\"`` \\| ``\"float\"`` \\| ``\"double\"`` \\| ``\"boolean\"`` \\| ``\"decimal\"`` \\| ``\"string\"`` \\| ``\"uuid\"`` \\| ``\"text\"`` }\\> ; `idPrefix?`: `string` ; `tableName?`: `string` } ; `extends?`: { `fieldAlias?`: Record<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\> ; `relationship`: [`ModuleJoinerRelationship`](../types/ModuleJoinerRelationship.mdx) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](../types/ModuleJoinerRelationship.mdx)[] ; `schema?`: `string` ; `serviceName?`: `string` }",
"type": "[Omit](../types/Omit.mdx)&#60;[JoinerServiceConfig](JoinerServiceConfig.mdx), `\"serviceName\"` \\| `\"primaryKeys\"` \\| `\"relationships\"` \\| `\"extends\"`&#62; & `&#123; databaseConfig?: &#123; extraFields?: Record&#60;string, &#123; defaultValue?: string ; nullable?: boolean ; options?: Record&#60;string, unknown&#62; ; type: `\"date\"` \\| `\"time\"` \\| `\"datetime\"` \\| `\"bigint\"` \\| `\"blob\"` \\| `\"uint8array\"` \\| `\"array\"` \\| `\"enumArray\"` \\| `\"enum\"` \\| `\"json\"` \\| `\"integer\"` \\| `\"smallint\"` \\| `\"tinyint\"` \\| `\"mediumint\"` \\| `\"float\"` \\| `\"double\"` \\| `\"boolean\"` \\| `\"decimal\"` \\| `\"string\"` \\| `\"uuid\"` \\| `\"text\"` &#125;&#62; ; idPrefix?: string ; tableName?: string &#125; ; extends?: &#123; fieldAlias?: Record&#60;string, string \\| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;&#62; ; relationship: [ModuleJoinerRelationship](../types/ModuleJoinerRelationship.mdx) ; serviceName: string &#125;[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record&#60;string, string&#62; ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](../types/ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -32,14 +32,14 @@ ___
### create
**create**(`input`, `context?`): `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\>
`**create**(input, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "input",
"type": "[`CreateStockLocationInput`](../types/CreateStockLocationInput.mdx)",
"type": "[CreateStockLocationInput](../types/CreateStockLocationInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -59,12 +59,12 @@ ___
#### Returns
`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\>
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -77,7 +77,7 @@ ___
### delete
**delete**(`id`, `context?`): `Promise`<`void`\>
`**delete**(id, context?): Promise&#60;void&#62;`
#### Parameters
@@ -93,7 +93,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -104,12 +104,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -122,14 +122,14 @@ ___
### list
**list**(`selector`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)[]\>
`**list**(selector, config?, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`FilterableStockLocationProps`](../types/FilterableStockLocationProps.mdx)",
"type": "[FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](FindConfig-1.mdx)<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "[FindConfig](FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -147,7 +147,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -158,12 +158,12 @@ ___
#### Returns
`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)[]\>
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)[]\\>",
"type": "Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -176,14 +176,14 @@ ___
### listAndCount
**listAndCount**(`selector`, `config?`, `context?`): `Promise`<[[`StockLocationDTO`](../types/StockLocationDTO.mdx)[], `number`]\>
`**listAndCount**(selector, config?, context?): Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`FilterableStockLocationProps`](../types/FilterableStockLocationProps.mdx)",
"type": "[FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](FindConfig-1.mdx)<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "[FindConfig](FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -201,7 +201,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -212,12 +212,12 @@ ___
#### Returns
`Promise`<[[`StockLocationDTO`](../types/StockLocationDTO.mdx)[], `number`]\>
Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`StockLocationDTO`](../types/StockLocationDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -230,7 +230,7 @@ ___
### retrieve
**retrieve**(`id`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\>
`**retrieve**(id, config?, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
#### Parameters
@@ -246,7 +246,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](FindConfig-1.mdx)<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "[FindConfig](FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -255,7 +255,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -266,12 +266,12 @@ ___
#### Returns
`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\>
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -284,7 +284,7 @@ ___
### update
**update**(`id`, `input`, `context?`): `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\>
`**update**(id, input, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
#### Parameters
@@ -300,7 +300,7 @@ ___
},
{
"name": "input",
"type": "[`UpdateStockLocationInput`](../types/UpdateStockLocationInput.mdx)",
"type": "[UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -309,7 +309,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -320,12 +320,12 @@ ___
#### Returns
`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\>
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",