asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#5743)

Browse Source 
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new BatchJobService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -195,29 +195,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Accessors
### activeManager\_
#### activeManager\_
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
`Protected` **activeManager\_**: [object Object]
## Methods
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -225,6 +209,8 @@ Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
@@ -246,7 +232,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -278,7 +264,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -296,11 +282,11 @@ Promise&#60;TResult&#62;
___
### cancel
#### cancel
`**cancel**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -314,7 +300,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -332,11 +318,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
### complete
#### complete
`**complete**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -350,7 +336,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -368,11 +354,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
### confirm
#### confirm
`**confirm**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -386,7 +372,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -404,11 +390,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
### create
#### create
`**create**(data): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -422,7 +408,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -440,11 +426,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
### listAndCount
#### listAndCount
`**listAndCount**(selector?, config?): Promise&#60;[[BatchJob](BatchJob.mdx)[], number]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -467,7 +453,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[[BatchJob](BatchJob.mdx)[], number]&#62;
@@ -485,11 +471,11 @@ Promise&#60;[[BatchJob](BatchJob.mdx)[], number]&#62;
___
### prepareBatchJobForProcessing
#### prepareBatchJobForProcessing
`**prepareBatchJobForProcessing**(data, req): Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -512,7 +498,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;
@@ -530,11 +516,11 @@ Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;
___
### retrieve
#### retrieve
`**retrieve**(batchJobId, config?): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -557,7 +543,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -575,11 +561,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
### setFailed
#### setFailed
`**setFailed**(batchJobOrId, error?): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -602,7 +588,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -620,11 +606,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
### setPreProcessingDone
#### setPreProcessingDone
`**setPreProcessingDone**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -638,7 +624,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -656,11 +642,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
### setProcessing
#### setProcessing
`**setProcessing**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -674,7 +660,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -692,11 +678,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -710,7 +696,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -728,11 +714,11 @@ ___
___
### update
#### update
`**update**(batchJobOrId, data): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -755,7 +741,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -773,11 +759,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
### updateStatus
#### updateStatus
`Protected **updateStatus**(batchJobOrId, status): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -800,7 +786,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -818,11 +804,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [BatchJobService](BatchJobService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -836,7 +822,7 @@ ___
}
]} />
#### Returns
##### Returns
[BatchJobService](BatchJobService.mdx)