docs: migrate guides to TSDoc references (#6100)

This commit is contained in:
Shahed Nasser
2024-01-22 19:38:35 +02:00
committed by GitHub
parent 85dad169bb
commit 4792c55226
980 changed files with 195537 additions and 160619 deletions

View File

@@ -50,8 +50,6 @@ transaction manager is created.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
### cancel
#### Parameters
@@ -62,8 +60,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### complete
#### Parameters
@@ -74,8 +70,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### confirm
#### Parameters
@@ -86,8 +80,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### create
#### Parameters
@@ -98,8 +90,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### listAndCount
#### Parameters
@@ -110,8 +100,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[BatchJob](../../entities/classes/entities.BatchJob.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### prepareBatchJobForProcessing
#### Parameters
@@ -122,8 +110,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[CreateBatchJobInput](../../medusa/types/medusa.CreateBatchJobInput.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### retrieve
#### Parameters
@@ -134,8 +120,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### setFailed
#### Parameters
@@ -146,8 +130,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### setPreProcessingDone
#### Parameters
@@ -158,8 +140,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### setProcessing
#### Parameters
@@ -170,8 +150,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### shouldRetryTransaction\_
#### Parameters
@@ -182,8 +160,6 @@ ___
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### update
#### Parameters
@@ -194,8 +170,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### updateStatus
#### Parameters
@@ -206,8 +180,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### withTransaction
#### Parameters