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

86
www/apps/docs/content/references/services/classes/DiscountConditionService.mdx
View File

@@ -14,14 +14,14 @@ Provides layer to manipulate discount conditions.
### constructor
**new DiscountConditionService**(`«destructured»`)
`**new DiscountConditionService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-8.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-8.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -35,7 +35,7 @@ Provides layer to manipulate discount conditions.
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -53,7 +53,7 @@ Provides layer to manipulate discount conditions.
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -62,7 +62,7 @@ Provides layer to manipulate discount conditions.
},
{
"name": "discountConditionRepository_",
"type": "`Repository`<[`DiscountCondition`](DiscountCondition.mdx)\\> & { `addConditionResources`: Method addConditionResources ; `canApplyForCustomer`: Method canApplyForCustomer ; `findOneWithDiscount`: Method findOneWithDiscount ; `getJoinTableResourceIdentifiers`: Method getJoinTableResourceIdentifiers ; `isValidForProduct`: Method isValidForProduct ; `queryConditionTable`: Method queryConditionTable ; `removeConditionResources`: Method removeConditionResources }",
"type": "Repository&#60;[DiscountCondition](DiscountCondition.mdx)&#62; & `&#123; addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -71,7 +71,7 @@ Provides layer to manipulate discount conditions.
},
{
"name": "eventBus_",
"type": "[`EventBusService`](EventBusService.mdx)",
"type": "[EventBusService](EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -80,7 +80,7 @@ Provides layer to manipulate discount conditions.
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -89,7 +89,7 @@ Provides layer to manipulate discount conditions.
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -102,16 +102,16 @@ Provides layer to manipulate discount conditions.
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -124,7 +124,7 @@ Provides layer to manipulate discount conditions.
### 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
@@ -156,7 +156,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": "",
@@ -165,7 +165,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": "",
@@ -174,7 +174,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": "",
@@ -185,12 +185,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",
@@ -203,7 +203,7 @@ ___
### delete
**delete**(`discountConditionId`): `Promise`<`void` \| [`DiscountCondition`](DiscountCondition.mdx)\>
`**delete**(discountConditionId): Promise&#60;void \| [DiscountCondition](DiscountCondition.mdx)&#62;`
#### Parameters
@@ -221,12 +221,12 @@ ___
#### Returns
`Promise`<`void` \| [`DiscountCondition`](DiscountCondition.mdx)\>
Promise&#60;void \| [DiscountCondition](DiscountCondition.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void` \\| [`DiscountCondition`](DiscountCondition.mdx)\\>",
"type": "Promise&#60;void \\| [DiscountCondition](DiscountCondition.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -239,14 +239,14 @@ ___
### removeResources
**removeResources**(`data`): `Promise`<`void`\>
`**removeResources**(data): Promise&#60;void&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`Omit`](../types/Omit.mdx)<[`DiscountConditionInput`](../types/DiscountConditionInput.mdx), ``\"id\"``\\> & { `id`: `string` }",
"type": "[Omit](../types/Omit.mdx)&#60;[DiscountConditionInput](../types/DiscountConditionInput.mdx), `\"id\"`&#62; & `&#123; id: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -257,12 +257,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -275,7 +275,7 @@ ___
### retrieve
**retrieve**(`conditionId`, `config?`): `Promise`<[`DiscountCondition`](DiscountCondition.mdx)\>
`**retrieve**(conditionId, config?): Promise&#60;[DiscountCondition](DiscountCondition.mdx)&#62;`
#### Parameters
@@ -291,7 +291,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`DiscountCondition`](DiscountCondition.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[DiscountCondition](DiscountCondition.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -302,12 +302,12 @@ ___
#### Returns
`Promise`<[`DiscountCondition`](DiscountCondition.mdx)\>
Promise&#60;[DiscountCondition](DiscountCondition.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`DiscountCondition`](DiscountCondition.mdx)\\>",
"type": "Promise&#60;[DiscountCondition](DiscountCondition.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -320,14 +320,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": "",
@@ -356,14 +356,14 @@ ___
### upsertCondition
**upsertCondition**(`data`, `overrideExisting?`): `Promise`<([`DiscountConditionProduct`](DiscountConditionProduct.mdx) \| [`DiscountConditionProductType`](DiscountConditionProductType.mdx) \| [`DiscountConditionProductCollection`](DiscountConditionProductCollection.mdx) \| [`DiscountConditionProductTag`](DiscountConditionProductTag.mdx) \| [`DiscountConditionCustomerGroup`](DiscountConditionCustomerGroup.mdx))[]\>
`**upsertCondition**(data, overrideExisting?): Promise&#60;([DiscountConditionProduct](DiscountConditionProduct.mdx) \| [DiscountConditionProductType](DiscountConditionProductType.mdx) \| [DiscountConditionProductCollection](DiscountConditionProductCollection.mdx) \| [DiscountConditionProductTag](DiscountConditionProductTag.mdx) \| [DiscountConditionCustomerGroup](DiscountConditionCustomerGroup.mdx))[]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`DiscountConditionInput`](../types/DiscountConditionInput.mdx)",
"type": "[DiscountConditionInput](../types/DiscountConditionInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -383,12 +383,12 @@ ___
#### Returns
`Promise`<([`DiscountConditionProduct`](DiscountConditionProduct.mdx) \| [`DiscountConditionProductType`](DiscountConditionProductType.mdx) \| [`DiscountConditionProductCollection`](DiscountConditionProductCollection.mdx) \| [`DiscountConditionProductTag`](DiscountConditionProductTag.mdx) \| [`DiscountConditionCustomerGroup`](DiscountConditionCustomerGroup.mdx))[]\>
Promise&#60;([DiscountConditionProduct](DiscountConditionProduct.mdx) \| [DiscountConditionProductType](DiscountConditionProductType.mdx) \| [DiscountConditionProductCollection](DiscountConditionProductCollection.mdx) \| [DiscountConditionProductTag](DiscountConditionProductTag.mdx) \| [DiscountConditionCustomerGroup](DiscountConditionCustomerGroup.mdx))[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<([`DiscountConditionProduct`](DiscountConditionProduct.mdx) \\| [`DiscountConditionProductType`](DiscountConditionProductType.mdx) \\| [`DiscountConditionProductCollection`](DiscountConditionProductCollection.mdx) \\| [`DiscountConditionProductTag`](DiscountConditionProductTag.mdx) \\| [`DiscountConditionCustomerGroup`](DiscountConditionCustomerGroup.mdx))[]\\>",
"type": "Promise&#60;([DiscountConditionProduct](DiscountConditionProduct.mdx) \\| [DiscountConditionProductType](DiscountConditionProductType.mdx) \\| [DiscountConditionProductCollection](DiscountConditionProductCollection.mdx) \\| [DiscountConditionProductTag](DiscountConditionProductTag.mdx) \\| [DiscountConditionCustomerGroup](DiscountConditionCustomerGroup.mdx))[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -401,14 +401,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`DiscountConditionService`](DiscountConditionService.mdx)
`**withTransaction**(transactionManager?): [DiscountConditionService](DiscountConditionService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -419,12 +419,12 @@ ___
#### Returns
[`DiscountConditionService`](DiscountConditionService.mdx)
[DiscountConditionService](DiscountConditionService.mdx)
<ParameterTypes parameters={[
{
"name": "DiscountConditionService",
"type": "[`DiscountConditionService`](DiscountConditionService.mdx)",
"type": "[DiscountConditionService](DiscountConditionService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -437,14 +437,14 @@ ___
### resolveConditionType\_
`Static` `Protected` **resolveConditionType_**(`data`): `undefined` \| { `resource_ids`: (`string` \| { `id`: `string` })[] ; `type`: [`DiscountConditionType`](../enums/DiscountConditionType.mdx) }
`Static Protected **resolveConditionType_**(data): undefined \| &#123; resource_ids: (string \| &#123; id: string &#125;)[] ; type: [DiscountConditionType](../enums/DiscountConditionType.mdx) &#125;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`DiscountConditionInput`](../types/DiscountConditionInput.mdx)",
"type": "[DiscountConditionInput](../types/DiscountConditionInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -455,12 +455,12 @@ ___
#### Returns
`undefined` \| { `resource_ids`: (`string` \| { `id`: `string` })[] ; `type`: [`DiscountConditionType`](../enums/DiscountConditionType.mdx) }
`undefined` \| `&#123; resource_ids: (string \| &#123; id: string &#125;)[] ; type: [DiscountConditionType](../enums/DiscountConditionType.mdx) &#125;`
<ParameterTypes parameters={[
{
"name": "undefined \\| { `resource_ids`: (`string` \\| { `id`: `string` })[] ; `type`: [`DiscountConditionType`](../enums/DiscountConditionType.mdx) }",
"type": "`undefined` \\| { `resource_ids`: (`string` \\| { `id`: `string` })[] ; `type`: [`DiscountConditionType`](../enums/DiscountConditionType.mdx) }",
"name": "undefined \\| &#123; resource_ids: (string \\| &#123; id: string &#125;)[] ; type: DiscountConditionType &#125;",
"type": "`undefined` \\| `&#123; resource_ids: (string \\| &#123; id: string &#125;)[] ; type: [DiscountConditionType](../enums/DiscountConditionType.mdx) &#125;`",
"optional": true,
"defaultValue": "",
"description": "",