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/classes/ClaimItemService.mdx
+41 -41
View File
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### constructor
**new ClaimItemService**(`«destructured»`)
`**new ClaimItemService**(«destructured»)`
#### Parameters
@@ -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": "claimImageRepository_",
"type": "`Repository`<[`ClaimImage`](ClaimImage.mdx)\\>",
"type": "Repository&#60;[ClaimImage](ClaimImage.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "claimItemRepository_",
"type": "`Repository`<[`ClaimItem`](ClaimItem.mdx)\\>",
"type": "Repository&#60;[ClaimItem](ClaimItem.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "claimTagRepository_",
"type": "`Repository`<[`ClaimTag`](ClaimTag.mdx)\\>",
"type": "Repository&#60;[ClaimTag](ClaimTag.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "eventBus_",
"type": "[`EventBusService`](EventBusService.mdx)",
"type": "[EventBusService](EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "lineItemService_",
"type": "[`LineItemService`](LineItemService.mdx)",
"type": "[LineItemService](LineItemService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -161,16 +161,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": "",
@@ -183,7 +183,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
@@ -215,7 +215,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": "",
@@ -224,7 +224,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": "",
@@ -233,7 +233,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": "",
@@ -244,12 +244,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",
@@ -262,14 +262,14 @@ ___
### create
**create**(`data`): `Promise`<[`ClaimItem`](ClaimItem.mdx)\>
`**create**(data): Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateClaimItemInput`](../types/CreateClaimItemInput.mdx)",
"type": "[CreateClaimItemInput](../types/CreateClaimItemInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -280,12 +280,12 @@ ___
#### Returns
`Promise`<[`ClaimItem`](ClaimItem.mdx)\>
Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ClaimItem`](ClaimItem.mdx)\\>",
"type": "Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -298,14 +298,14 @@ ___
### list
**list**(`selector`, `config?`): `Promise`<[`ClaimItem`](ClaimItem.mdx)[]\>
`**list**(selector, config?): Promise&#60;[ClaimItem](ClaimItem.mdx)[]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`Selector`](../types/Selector.mdx)<[`ClaimItem`](ClaimItem.mdx)\\>",
"type": "[Selector](../types/Selector.mdx)&#60;[ClaimItem](ClaimItem.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
@@ -314,7 +314,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`ClaimItem`](ClaimItem.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[ClaimItem](ClaimItem.mdx)&#62;",
"description": "the config object for find",
"optional": false,
"defaultValue": "",
@@ -325,12 +325,12 @@ ___
#### Returns
`Promise`<[`ClaimItem`](ClaimItem.mdx)[]\>
Promise&#60;[ClaimItem](ClaimItem.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ClaimItem`](ClaimItem.mdx)[]\\>",
"type": "Promise&#60;[ClaimItem](ClaimItem.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
@@ -343,7 +343,7 @@ ___
### retrieve
**retrieve**(`claimItemId`, `config?`): `Promise`<[`ClaimItem`](ClaimItem.mdx)\>
`**retrieve**(claimItemId, config?): Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;`
Gets a claim item by id.
@@ -361,7 +361,7 @@ Gets a claim item by id.
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`ClaimItem`](ClaimItem.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[ClaimItem](ClaimItem.mdx)&#62;",
"description": "configuration for the find operation",
"optional": false,
"defaultValue": "{}",
@@ -372,12 +372,12 @@ Gets a claim item by id.
#### Returns
`Promise`<[`ClaimItem`](ClaimItem.mdx)\>
Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ClaimItem`](ClaimItem.mdx)\\>",
"type": "Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the ClaimItem",
@@ -390,14 +390,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": "",
@@ -426,7 +426,7 @@ ___
### update
**update**(`id`, `data`): `Promise`<[`ClaimItem`](ClaimItem.mdx)\>
`**update**(id, data): Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;`
#### Parameters
@@ -453,12 +453,12 @@ ___
#### Returns
`Promise`<[`ClaimItem`](ClaimItem.mdx)\>
Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ClaimItem`](ClaimItem.mdx)\\>",
"type": "Promise&#60;[ClaimItem](ClaimItem.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -471,14 +471,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`ClaimItemService`](ClaimItemService.mdx)
`**withTransaction**(transactionManager?): [ClaimItemService](ClaimItemService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -489,12 +489,12 @@ ___
#### Returns
[`ClaimItemService`](ClaimItemService.mdx)
[ClaimItemService](ClaimItemService.mdx)
<ParameterTypes parameters={[
{
"name": "ClaimItemService",
"type": "[`ClaimItemService`](ClaimItemService.mdx)",
"type": "[ClaimItemService](ClaimItemService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",