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

docs: TSDoc + reference of fulfillment service (#5761)

Browse Source
This commit is contained in:
Shahed Nasser
2023-11-29 11:58:08 +00:00
committed by GitHub
parent 8f25ed8a10
commit f802e2460f
1479 changed files with 30259 additions and 16135 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/classes/BatchJobService.mdx
+72 -52
View File
@@ -6,13 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# BatchJobService
## Constructors
#### constructor
## constructor
`**new BatchJobService**(«destructured»)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -26,6 +24,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -193,15 +193,35 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Accessors
#### activeManager\_
### activeManager\_
`Protected` **activeManager\_**: [object Object]
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## Methods
#### atomicPhase\_
### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -209,7 +229,7 @@ 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
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -232,7 +252,7 @@ transaction manager is created.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -264,7 +284,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -282,11 +302,11 @@ Promise&#60;TResult&#62;
___
#### cancel
### cancel
`**cancel**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -300,7 +320,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -318,11 +338,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
#### complete
### complete
`**complete**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -336,7 +356,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -354,11 +374,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
#### confirm
### confirm
`**confirm**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -372,7 +392,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -390,11 +410,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
#### create
### create
`**create**(data): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -408,7 +428,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -426,11 +446,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
#### listAndCount
### listAndCount
`**listAndCount**(selector?, config?): Promise&#60;[[BatchJob](BatchJob.mdx)[], number]&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -453,7 +473,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[[BatchJob](BatchJob.mdx)[], number]&#62;
@@ -471,11 +491,11 @@ Promise&#60;[[BatchJob](BatchJob.mdx)[], number]&#62;
___
#### prepareBatchJobForProcessing
### prepareBatchJobForProcessing
`**prepareBatchJobForProcessing**(data, req): Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -498,7 +518,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;
@@ -516,11 +536,11 @@ Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;
___
#### retrieve
### retrieve
`**retrieve**(batchJobId, config?): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -543,7 +563,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -561,11 +581,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
#### setFailed
### setFailed
`**setFailed**(batchJobOrId, error?): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -588,7 +608,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -606,11 +626,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
#### setPreProcessingDone
### setPreProcessingDone
`**setPreProcessingDone**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -624,7 +644,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -642,11 +662,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
#### setProcessing
### setProcessing
`**setProcessing**(batchJobOrId): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -660,7 +680,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -678,11 +698,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -696,7 +716,7 @@ ___
}
]} />
##### Returns
#### Returns
`boolean`
@@ -714,11 +734,11 @@ ___
___
#### update
### update
`**update**(batchJobOrId, data): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -741,7 +761,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -759,11 +779,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
#### updateStatus
### updateStatus
`Protected **updateStatus**(batchJobOrId, status): Promise&#60;[BatchJob](BatchJob.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -786,7 +806,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[BatchJob](BatchJob.mdx)&#62;
@@ -804,11 +824,11 @@ Promise&#60;[BatchJob](BatchJob.mdx)&#62;
___
#### withTransaction
### withTransaction
`**withTransaction**(transactionManager?): [BatchJobService](BatchJobService.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -822,7 +842,7 @@ ___
}
]} />
##### Returns
#### Returns
[BatchJobService](BatchJobService.mdx)