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

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

View File

@@ -10,13 +10,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [IBatchJobStrategy](../interfaces/IBatchJobStrategy.mdx)
## Constructors
#### constructor
## constructor
`Protected **new AbstractBatchJobStrategy**(__container__, __configModule__?, __moduleDeclaration__?)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -48,6 +46,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -125,15 +125,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;`
@@ -141,7 +161,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={[
{
@@ -164,7 +184,7 @@ transaction manager is created.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -196,7 +216,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -214,13 +234,13 @@ Promise&#60;TResult&#62;
___
#### buildTemplate
### buildTemplate
`Abstract **buildTemplate**(): Promise&#60;string&#62;`
Builds and returns a template file that can be downloaded and filled in
##### Returns
#### Returns
Promise&#60;string&#62;
@@ -238,11 +258,11 @@ Promise&#60;string&#62;
___
#### handleProcessingError
### handleProcessingError
`Protected **handleProcessingError**<TypeParameter T>(batchJobId, err, result): Promise&#60;void&#62;`
##### Type Parameters
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -256,7 +276,7 @@ ___
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -288,7 +308,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -306,13 +326,13 @@ Promise&#60;void&#62;
___
#### preProcessBatchJob
### preProcessBatchJob
`**preProcessBatchJob**(batchJobId): Promise&#60;void&#62;`
Method for pre-processing a batch job
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -326,7 +346,7 @@ Method for pre-processing a batch job
}
]} />
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -344,13 +364,13 @@ Promise&#60;void&#62;
___
#### prepareBatchJobForProcessing
### prepareBatchJobForProcessing
`**prepareBatchJobForProcessing**(batchJob, req): Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;`
Method for preparing a batch job for processing
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -373,7 +393,7 @@ Method for preparing a batch job for processing
}
]} />
##### Returns
#### Returns
Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;
@@ -391,13 +411,13 @@ Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;
___
#### processJob
### processJob
`Abstract **processJob**(batchJobId): Promise&#60;void&#62;`
Method does the actual processing of the job. Should report back on the progress of the operation.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -411,7 +431,7 @@ Method does the actual processing of the job. Should report back on the progress
}
]} />
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -429,11 +449,11 @@ Promise&#60;void&#62;
___
#### shouldRetryOnProcessingError
### shouldRetryOnProcessingError
`Protected **shouldRetryOnProcessingError**(batchJob, err): Promise&#60;boolean&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -456,7 +476,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;boolean&#62;
@@ -474,11 +494,11 @@ Promise&#60;boolean&#62;
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -492,7 +512,7 @@ ___
}
]} />
##### Returns
#### Returns
`boolean`
@@ -510,11 +530,11 @@ ___
___
#### withTransaction
### withTransaction
`**withTransaction**(transactionManager?): [AbstractBatchJobStrategy](AbstractBatchJobStrategy.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -528,7 +548,7 @@ ___
}
]} />
##### Returns
#### Returns
[AbstractBatchJobStrategy](AbstractBatchJobStrategy.mdx)