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

88
www/apps/docs/content/references/services/classes/AbstractBatchJobStrategy.mdx
View File

@@ -8,13 +8,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Implements
- [`IBatchJobStrategy`](../interfaces/IBatchJobStrategy.mdx)
- [IBatchJobStrategy](../interfaces/IBatchJobStrategy.mdx)
## Constructors
### constructor
`Protected` **new AbstractBatchJobStrategy**(`__container__`, `__configModule__?`, `__moduleDeclaration__?`)
`Protected **new AbstractBatchJobStrategy**(__container__, __configModule__?, __moduleDeclaration__?)`
#### Parameters
@@ -30,7 +30,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -39,7 +39,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -53,7 +53,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -71,7 +71,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -80,7 +80,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "batchJobService_",
"type": "[`BatchJobService`](BatchJobService.mdx)",
"type": "[BatchJobService](BatchJobService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -89,7 +89,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -98,7 +98,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -129,16 +129,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": "",
@@ -151,7 +151,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
@@ -183,7 +183,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": "",
@@ -192,7 +192,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": "",
@@ -201,7 +201,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": "",
@@ -212,12 +212,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",
@@ -230,18 +230,18 @@ ___
### buildTemplate
`Abstract` **buildTemplate**(): `Promise`<`string`\>
`Abstract **buildTemplate**(): Promise&#60;string&#62;`
Builds and returns a template file that can be downloaded and filled in
#### Returns
`Promise`<`string`\>
Promise&#60;string&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`string`\\>",
"type": "Promise&#60;string&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -254,7 +254,7 @@ ___
### handleProcessingError
`Protected` **handleProcessingError**<`T`\>(`batchJobId`, `err`, `result`): `Promise`<`void`\>
`Protected **handleProcessingError**<TypeParameter T>(batchJobId, err, result): Promise&#60;void&#62;`
<ParameterTypes parameters={[
{
@@ -302,12 +302,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -320,7 +320,7 @@ ___
### preProcessBatchJob
**preProcessBatchJob**(`batchJobId`): `Promise`<`void`\>
`**preProcessBatchJob**(batchJobId): Promise&#60;void&#62;`
Method for pre-processing a batch job
@@ -340,12 +340,12 @@ Method for pre-processing a batch job
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -358,7 +358,7 @@ ___
### prepareBatchJobForProcessing
**prepareBatchJobForProcessing**(`batchJob`, `req`): `Promise`<[`CreateBatchJobInput`](../types/CreateBatchJobInput.mdx)\>
`**prepareBatchJobForProcessing**(batchJob, req): Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;`
Method for preparing a batch job for processing
@@ -367,7 +367,7 @@ Method for preparing a batch job for processing
<ParameterTypes parameters={[
{
"name": "batchJob",
"type": "[`CreateBatchJobInput`](../types/CreateBatchJobInput.mdx)",
"type": "[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -387,12 +387,12 @@ Method for preparing a batch job for processing
#### 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": "",
@@ -405,7 +405,7 @@ ___
### processJob
`Abstract` **processJob**(`batchJobId`): `Promise`<`void`\>
`Abstract **processJob**(batchJobId): Promise&#60;void&#62;`
Method does the actual processing of the job. Should report back on the progress of the operation.
@@ -425,12 +425,12 @@ Method does the actual processing of the job. Should report back on the progress
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -443,14 +443,14 @@ ___
### shouldRetryOnProcessingError
`Protected` **shouldRetryOnProcessingError**(`batchJob`, `err`): `Promise`<`boolean`\>
`Protected **shouldRetryOnProcessingError**(batchJob, err): Promise&#60;boolean&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJob",
"type": "[`BatchJob`](BatchJob.mdx)",
"type": "[BatchJob](BatchJob.mdx)",
"description": "A Batch Job indicates an asynchronus task stored in the Medusa backend. Its status determines whether it has been executed or not.",
"optional": false,
"defaultValue": "",
@@ -470,12 +470,12 @@ ___
#### Returns
`Promise`<`boolean`\>
Promise&#60;boolean&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`boolean`\\>",
"type": "Promise&#60;boolean&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -488,14 +488,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": "",
@@ -524,14 +524,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`AbstractBatchJobStrategy`](AbstractBatchJobStrategy.mdx)
`**withTransaction**(transactionManager?): [AbstractBatchJobStrategy](AbstractBatchJobStrategy.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -542,12 +542,12 @@ ___
#### Returns
[`AbstractBatchJobStrategy`](AbstractBatchJobStrategy.mdx)
[AbstractBatchJobStrategy](AbstractBatchJobStrategy.mdx)
<ParameterTypes parameters={[
{
"name": "AbstractBatchJobStrategy",
"type": "[`AbstractBatchJobStrategy`](AbstractBatchJobStrategy.mdx)",
"type": "[AbstractBatchJobStrategy](AbstractBatchJobStrategy.mdx)",
"optional": false,
"defaultValue": "",
"description": "",