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

68
www/apps/docs/content/references/services/classes/CustomShippingOptionService.mdx
View File

@@ -10,14 +10,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### constructor
**new CustomShippingOptionService**(`«destructured»`)
`**new CustomShippingOptionService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-6.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-6.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": "customShippingOptionRepository_",
"type": "`Repository`<[`CustomShippingOption`](CustomShippingOption.mdx)\\>",
"type": "Repository&#60;[CustomShippingOption](CustomShippingOption.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -89,16 +89,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": "",
@@ -111,7 +111,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
@@ -143,7 +143,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": "",
@@ -152,7 +152,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": "",
@@ -161,7 +161,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": "",
@@ -172,12 +172,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",
@@ -190,7 +190,7 @@ ___
### create
**create**<`T`, `TResult`\>(`data`): `Promise`<`TResult`\>
`**create**<TypeParameter T, TypeParameter TResult>(data): Promise&#60;TResult&#62;`
Creates a custom shipping option
@@ -231,12 +231,12 @@ Creates a custom shipping option
#### Returns
`Promise`<`TResult`\>
Promise&#60;TResult&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`TResult`\\>",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "resolves to the creation result",
@@ -249,7 +249,7 @@ ___
### list
**list**(`selector`, `config?`): `Promise`<[`CustomShippingOption`](CustomShippingOption.mdx)[]\>
`**list**(selector, config?): Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)[]&#62;`
Fetches all custom shipping options based on the given selector
@@ -258,7 +258,7 @@ Fetches all custom shipping options based on the given selector
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`Selector`](../types/Selector.mdx)<[`CustomShippingOption`](CustomShippingOption.mdx)\\>",
"type": "[Selector](../types/Selector.mdx)&#60;[CustomShippingOption](CustomShippingOption.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
@@ -267,7 +267,7 @@ Fetches all custom shipping options based on the given selector
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`CustomShippingOption`](CustomShippingOption.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[CustomShippingOption](CustomShippingOption.mdx)&#62;",
"description": "the configuration used to find the objects. contains relations, skip, and take.",
"optional": false,
"defaultValue": "",
@@ -278,12 +278,12 @@ Fetches all custom shipping options based on the given selector
#### Returns
`Promise`<[`CustomShippingOption`](CustomShippingOption.mdx)[]\>
Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`CustomShippingOption`](CustomShippingOption.mdx)[]\\>",
"type": "Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "custom shipping options matching the query",
@@ -296,7 +296,7 @@ ___
### retrieve
**retrieve**(`id`, `config?`): `Promise`<[`CustomShippingOption`](CustomShippingOption.mdx)\>
`**retrieve**(id, config?): Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)&#62;`
Retrieves a specific shipping option.
@@ -314,7 +314,7 @@ Retrieves a specific shipping option.
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`CustomShippingOption`](CustomShippingOption.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[CustomShippingOption](CustomShippingOption.mdx)&#62;",
"description": "any options needed to query for the result.",
"optional": false,
"defaultValue": "{}",
@@ -325,12 +325,12 @@ Retrieves a specific shipping option.
#### Returns
`Promise`<[`CustomShippingOption`](CustomShippingOption.mdx)\>
Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`CustomShippingOption`](CustomShippingOption.mdx)\\>",
"type": "Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the requested custom shipping option.",
@@ -343,14 +343,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": "",
@@ -379,14 +379,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`CustomShippingOptionService`](CustomShippingOptionService.mdx)
`**withTransaction**(transactionManager?): [CustomShippingOptionService](CustomShippingOptionService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -397,12 +397,12 @@ ___
#### Returns
[`CustomShippingOptionService`](CustomShippingOptionService.mdx)
[CustomShippingOptionService](CustomShippingOptionService.mdx)
<ParameterTypes parameters={[
{
"name": "CustomShippingOptionService",
"type": "[`CustomShippingOptionService`](CustomShippingOptionService.mdx)",
"type": "[CustomShippingOptionService](CustomShippingOptionService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",