asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 3 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/classes/OrderEditItemChangeService.mdx
+41 -41
View File
@@ -10,14 +10,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### constructor
**new OrderEditItemChangeService**(`«destructured»`)
`**new OrderEditItemChangeService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-21.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-21.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -49,7 +49,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "eventBus_",
"type": "[`IEventBusService`](../interfaces/IEventBusService.mdx)",
"type": "[IEventBusService](../interfaces/IEventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "lineItemService_",
"type": "[`LineItemService`](LineItemService.mdx)",
"type": "[LineItemService](LineItemService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "orderItemChangeRepository_",
"type": "`Repository`<[`OrderItemChange`](OrderItemChange.mdx)\\>",
"type": "Repository&#60;[OrderItemChange](OrderItemChange.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "taxProviderService_",
"type": "[`TaxProviderService`](TaxProviderService.mdx)",
"type": "[TaxProviderService](TaxProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -143,16 +143,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -165,7 +165,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### atomicPhase\_
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
@@ -197,7 +197,7 @@ transaction manager is created.
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => `Promise`<`TResult`\\>",
"type": "(`transactionManager`: EntityManager) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
@@ -206,7 +206,7 @@ transaction manager is created.
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
@@ -215,7 +215,7 @@ transaction manager is created.
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
@@ -226,12 +226,12 @@ transaction manager is created.
#### Returns
`Promise`<`TResult`\>
Promise&#60;TResult&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`TResult`\\>",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
@@ -244,14 +244,14 @@ ___
### create
**create**(`data`): `Promise`<[`OrderItemChange`](OrderItemChange.mdx)\>
`**create**(data): Promise&#60;[OrderItemChange](OrderItemChange.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateOrderEditItemChangeInput`](../types/CreateOrderEditItemChangeInput.mdx)",
"type": "[CreateOrderEditItemChangeInput](../types/CreateOrderEditItemChangeInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -262,12 +262,12 @@ ___
#### Returns
`Promise`<[`OrderItemChange`](OrderItemChange.mdx)\>
Promise&#60;[OrderItemChange](OrderItemChange.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`OrderItemChange`](OrderItemChange.mdx)\\>",
"type": "Promise&#60;[OrderItemChange](OrderItemChange.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -280,7 +280,7 @@ ___
### delete
**delete**(`itemChangeIds`): `Promise`<`void`\>
`**delete**(itemChangeIds): Promise&#60;void&#62;`
#### Parameters
@@ -298,12 +298,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -316,14 +316,14 @@ ___
### list
**list**(`selector`, `config?`): `Promise`<[`OrderItemChange`](OrderItemChange.mdx)[]\>
`**list**(selector, config?): Promise&#60;[OrderItemChange](OrderItemChange.mdx)[]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`Selector`](../types/Selector.mdx)<[`OrderItemChange`](OrderItemChange.mdx)\\>",
"type": "[Selector](../types/Selector.mdx)&#60;[OrderItemChange](OrderItemChange.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -332,7 +332,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`OrderItemChange`](OrderItemChange.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[OrderItemChange](OrderItemChange.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
@@ -343,12 +343,12 @@ ___
#### Returns
`Promise`<[`OrderItemChange`](OrderItemChange.mdx)[]\>
Promise&#60;[OrderItemChange](OrderItemChange.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`OrderItemChange`](OrderItemChange.mdx)[]\\>",
"type": "Promise&#60;[OrderItemChange](OrderItemChange.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -361,7 +361,7 @@ ___
### retrieve
**retrieve**(`id`, `config?`): `Promise`<[`OrderItemChange`](OrderItemChange.mdx)\>
`**retrieve**(id, config?): Promise&#60;[OrderItemChange](OrderItemChange.mdx)&#62;`
#### Parameters
@@ -377,7 +377,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`OrderItemChange`](OrderItemChange.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[OrderItemChange](OrderItemChange.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
@@ -388,12 +388,12 @@ ___
#### Returns
`Promise`<[`OrderItemChange`](OrderItemChange.mdx)\>
Promise&#60;[OrderItemChange](OrderItemChange.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`OrderItemChange`](OrderItemChange.mdx)\\>",
"type": "Promise&#60;[OrderItemChange](OrderItemChange.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -406,14 +406,14 @@ ___
### shouldRetryTransaction\_
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "Record<`string`, `unknown`\\> \\| { `code`: `string` }",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -442,14 +442,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`OrderEditItemChangeService`](OrderEditItemChangeService.mdx)
`**withTransaction**(transactionManager?): [OrderEditItemChangeService](OrderEditItemChangeService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -460,12 +460,12 @@ ___
#### Returns
[`OrderEditItemChangeService`](OrderEditItemChangeService.mdx)
[OrderEditItemChangeService](OrderEditItemChangeService.mdx)
<ParameterTypes parameters={[
{
"name": "default",
"type": "[`OrderEditItemChangeService`](OrderEditItemChangeService.mdx)",
"type": "[OrderEditItemChangeService](OrderEditItemChangeService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",