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
@@ -6,13 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# TransactionBaseService
## Constructors
#### constructor
## constructor
`Protected **new TransactionBaseService**(__container__, __configModule__?, __moduleDeclaration__?)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -44,6 +42,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -94,15 +94,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;`
@@ -110,7 +130,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={[
{
@@ -133,7 +153,7 @@ transaction manager is created.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -165,7 +185,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -183,11 +203,11 @@ Promise&#60;TResult&#62;
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -201,7 +221,7 @@ ___
}
]} />
##### Returns
#### Returns
`boolean`
@@ -219,11 +239,11 @@ ___
___
#### withTransaction
### withTransaction
`**withTransaction**(transactionManager?): [TransactionBaseService](TransactionBaseService.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -237,7 +257,7 @@ ___
}
]} />
##### Returns
#### Returns
[TransactionBaseService](TransactionBaseService.mdx)