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

156
www/apps/docs/content/references/services/classes/BatchJobService.mdx
View File

@@ -10,14 +10,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### constructor
**new BatchJobService**(`«destructured»`)
`**new BatchJobService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-2.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-2.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": "batchJobRepository_",
"type": "`Repository`<[`BatchJob`](BatchJob.mdx)\\>",
"type": "Repository&#60;[BatchJob](BatchJob.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "batchJobStatusMapToProps",
"type": "`Map`<[`BatchJobStatus`](../enums/BatchJobStatus.mdx), { `entityColumnName`: `string` ; `eventType`: `string` }\\>",
"type": "Map&#60;[BatchJobStatus](../enums/BatchJobStatus.mdx), &#123; entityColumnName: string ; eventType: string &#125;&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "eventBus_",
"type": "[`EventBusService`](EventBusService.mdx)",
"type": "[EventBusService](EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "strategyResolver_",
"type": "[`StrategyResolverService`](StrategyResolverService.mdx)",
"type": "[StrategyResolverService](StrategyResolverService.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": "",
@@ -197,16 +197,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": "",
@@ -219,7 +219,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
@@ -251,7 +251,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": "",
@@ -260,7 +260,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": "",
@@ -269,7 +269,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": "",
@@ -280,12 +280,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",
@@ -298,14 +298,14 @@ ___
### cancel
**cancel**(`batchJobOrId`): `Promise`<[`BatchJob`](BatchJob.mdx)\>
`**cancel**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [`BatchJob`](BatchJob.mdx)",
"type": "`string` \\| [BatchJob](BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -316,12 +316,12 @@ ___
#### Returns
`Promise`<[`BatchJob`](BatchJob.mdx)\>
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`BatchJob`](BatchJob.mdx)\\>",
"type": "Promise&#60;[BatchJob](BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -334,14 +334,14 @@ ___
### complete
**complete**(`batchJobOrId`): `Promise`<[`BatchJob`](BatchJob.mdx)\>
`**complete**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [`BatchJob`](BatchJob.mdx)",
"type": "`string` \\| [BatchJob](BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -352,12 +352,12 @@ ___
#### Returns
`Promise`<[`BatchJob`](BatchJob.mdx)\>
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`BatchJob`](BatchJob.mdx)\\>",
"type": "Promise&#60;[BatchJob](BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -370,14 +370,14 @@ ___
### confirm
**confirm**(`batchJobOrId`): `Promise`<[`BatchJob`](BatchJob.mdx)\>
`**confirm**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [`BatchJob`](BatchJob.mdx)",
"type": "`string` \\| [BatchJob](BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -388,12 +388,12 @@ ___
#### Returns
`Promise`<[`BatchJob`](BatchJob.mdx)\>
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`BatchJob`](BatchJob.mdx)\\>",
"type": "Promise&#60;[BatchJob](BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -406,14 +406,14 @@ ___
### create
**create**(`data`): `Promise`<[`BatchJob`](BatchJob.mdx)\>
`**create**(data): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`BatchJobCreateProps`](../types/BatchJobCreateProps.mdx)",
"type": "[BatchJobCreateProps](../types/BatchJobCreateProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -424,12 +424,12 @@ ___
#### Returns
`Promise`<[`BatchJob`](BatchJob.mdx)\>
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`BatchJob`](BatchJob.mdx)\\>",
"type": "Promise&#60;[BatchJob](BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -442,14 +442,14 @@ ___
### listAndCount
**listAndCount**(`selector?`, `config?`): `Promise`<[[`BatchJob`](BatchJob.mdx)[], `number`]\>
`**listAndCount**(selector?, config?): Promise&#60;[[BatchJob](BatchJob.mdx)[], number]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`FilterableBatchJobProps`](FilterableBatchJobProps.mdx)",
"type": "[FilterableBatchJobProps](FilterableBatchJobProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "{}",
@@ -458,7 +458,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`BatchJob`](BatchJob.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[BatchJob](BatchJob.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -469,12 +469,12 @@ ___
#### Returns
`Promise`<[[`BatchJob`](BatchJob.mdx)[], `number`]\>
Promise&#60;[[BatchJob](BatchJob.mdx)[], number]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`BatchJob`](BatchJob.mdx)[], `number`]\\>",
"type": "Promise&#60;[[BatchJob](BatchJob.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -487,14 +487,14 @@ ___
### prepareBatchJobForProcessing
**prepareBatchJobForProcessing**(`data`, `req`): `Promise`<[`CreateBatchJobInput`](../types/CreateBatchJobInput.mdx)\>
`**prepareBatchJobForProcessing**(data, req): Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateBatchJobInput`](../types/CreateBatchJobInput.mdx)",
"type": "[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -503,7 +503,7 @@ ___
},
{
"name": "req",
"type": "`Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\\>\\>",
"type": "Request&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -514,12 +514,12 @@ ___
#### Returns
`Promise`<[`CreateBatchJobInput`](../types/CreateBatchJobInput.mdx)\>
Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`CreateBatchJobInput`](../types/CreateBatchJobInput.mdx)\\>",
"type": "Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -532,7 +532,7 @@ ___
### retrieve
**retrieve**(`batchJobId`, `config?`): `Promise`<[`BatchJob`](BatchJob.mdx)\>
`**retrieve**(batchJobId, config?): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
@@ -548,7 +548,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`BatchJob`](BatchJob.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[BatchJob](BatchJob.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
@@ -559,12 +559,12 @@ ___
#### Returns
`Promise`<[`BatchJob`](BatchJob.mdx)\>
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`BatchJob`](BatchJob.mdx)\\>",
"type": "Promise&#60;[BatchJob](BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -577,14 +577,14 @@ ___
### setFailed
**setFailed**(`batchJobOrId`, `error?`): `Promise`<[`BatchJob`](BatchJob.mdx)\>
`**setFailed**(batchJobOrId, error?): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [`BatchJob`](BatchJob.mdx)",
"type": "`string` \\| [BatchJob](BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -593,7 +593,7 @@ ___
},
{
"name": "error",
"type": "`string` \\| [`BatchJobResultError`](../types/BatchJobResultError.mdx)",
"type": "`string` \\| [BatchJobResultError](../types/BatchJobResultError.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -604,12 +604,12 @@ ___
#### Returns
`Promise`<[`BatchJob`](BatchJob.mdx)\>
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`BatchJob`](BatchJob.mdx)\\>",
"type": "Promise&#60;[BatchJob](BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -622,14 +622,14 @@ ___
### setPreProcessingDone
**setPreProcessingDone**(`batchJobOrId`): `Promise`<[`BatchJob`](BatchJob.mdx)\>
`**setPreProcessingDone**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [`BatchJob`](BatchJob.mdx)",
"type": "`string` \\| [BatchJob](BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -640,12 +640,12 @@ ___
#### Returns
`Promise`<[`BatchJob`](BatchJob.mdx)\>
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`BatchJob`](BatchJob.mdx)\\>",
"type": "Promise&#60;[BatchJob](BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -658,14 +658,14 @@ ___
### setProcessing
**setProcessing**(`batchJobOrId`): `Promise`<[`BatchJob`](BatchJob.mdx)\>
`**setProcessing**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [`BatchJob`](BatchJob.mdx)",
"type": "`string` \\| [BatchJob](BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -676,12 +676,12 @@ ___
#### Returns
`Promise`<[`BatchJob`](BatchJob.mdx)\>
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`BatchJob`](BatchJob.mdx)\\>",
"type": "Promise&#60;[BatchJob](BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -694,14 +694,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": "",
@@ -730,14 +730,14 @@ ___
### update
**update**(`batchJobOrId`, `data`): `Promise`<[`BatchJob`](BatchJob.mdx)\>
`**update**(batchJobOrId, data): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [`BatchJob`](BatchJob.mdx)",
"type": "`string` \\| [BatchJob](BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -746,7 +746,7 @@ ___
},
{
"name": "data",
"type": "[`Partial`](../types/Partial.mdx)<[`Pick`](../types/Pick.mdx)<[`BatchJob`](BatchJob.mdx), ``\"context\"`` \\| ``\"result\"``\\>\\>",
"type": "[Partial](../types/Partial.mdx)&#60;[Pick](../types/Pick.mdx)&#60;[BatchJob](BatchJob.mdx), `\"context\"` \\| `\"result\"`&#62;&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -757,12 +757,12 @@ ___
#### Returns
`Promise`<[`BatchJob`](BatchJob.mdx)\>
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`BatchJob`](BatchJob.mdx)\\>",
"type": "Promise&#60;[BatchJob](BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -775,14 +775,14 @@ ___
### updateStatus
`Protected` **updateStatus**(`batchJobOrId`, `status`): `Promise`<[`BatchJob`](BatchJob.mdx)\>
`Protected **updateStatus**(batchJobOrId, status): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [`BatchJob`](BatchJob.mdx)",
"type": "`string` \\| [BatchJob](BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -791,7 +791,7 @@ ___
},
{
"name": "status",
"type": "[`BatchJobStatus`](../enums/BatchJobStatus.mdx)",
"type": "[BatchJobStatus](../enums/BatchJobStatus.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -802,12 +802,12 @@ ___
#### Returns
`Promise`<[`BatchJob`](BatchJob.mdx)\>
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`BatchJob`](BatchJob.mdx)\\>",
"type": "Promise&#60;[BatchJob](BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -820,14 +820,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`BatchJobService`](BatchJobService.mdx)
`**withTransaction**(transactionManager?): [BatchJobService](BatchJobService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -838,12 +838,12 @@ ___
#### Returns
[`BatchJobService`](BatchJobService.mdx)
[BatchJobService](BatchJobService.mdx)
<ParameterTypes parameters={[
{
"name": "BatchJobService",
"type": "[`BatchJobService`](BatchJobService.mdx)",
"type": "[BatchJobService](BatchJobService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",