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

@@ -13,13 +13,11 @@ subscribers when events happen. Events will run asynchronously.
- [IEventBusService](../interfaces/IEventBusService.mdx)
## Constructors
#### constructor
## constructor
`**new EventBusService**(«destructured», config, isSingleton?)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -51,6 +49,8 @@ subscribers when events happen. Events will run asynchronously.
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -146,21 +146,57 @@ subscribers when events happen. Events will run asynchronously.
}
]} />
___
## 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": []
}
]} />
___
#### eventBusModuleService\_
### eventBusModuleService\_
`Protected` **eventBusModuleService\_**: [object Object]
`Protected get**eventBusModuleService_**(): [IEventBusModuleService](../interfaces/IEventBusModuleService.mdx)`
#### Returns
[IEventBusModuleService](../interfaces/IEventBusModuleService.mdx)
<ParameterTypes parameters={[
{
"name": "IEventBusModuleService",
"type": "[IEventBusModuleService](../interfaces/IEventBusModuleService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## Methods
#### atomicPhase\_
### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -168,7 +204,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={[
{
@@ -191,7 +227,7 @@ transaction manager is created.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -223,7 +259,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -241,13 +277,13 @@ Promise&#60;TResult&#62;
___
#### emit
### emit
`**emit**<TypeParameter T>(data): Promise&#60;void \| [StagedJob](StagedJob.mdx)[]&#62;`
Calls all subscribers when an event occurs.
##### Type Parameters
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -261,7 +297,7 @@ Calls all subscribers when an event occurs.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -275,7 +311,7 @@ Calls all subscribers when an event occurs.
}
]} />
##### Returns
#### Returns
Promise&#60;void \| [StagedJob](StagedJob.mdx)[]&#62;
@@ -295,7 +331,7 @@ Promise&#60;void \| [StagedJob](StagedJob.mdx)[]&#62;
Calls all subscribers when an event occurs.
##### Type Parameters
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -309,7 +345,7 @@ Calls all subscribers when an event occurs.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -341,7 +377,7 @@ Calls all subscribers when an event occurs.
}
]} />
##### Returns
#### Returns
Promise&#60;void \| [StagedJob](StagedJob.mdx)&#62;
@@ -359,11 +395,11 @@ Promise&#60;void \| [StagedJob](StagedJob.mdx)&#62;
___
#### enqueuer\_
### enqueuer\_
`**enqueuer_**(): Promise&#60;void&#62;`
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -381,11 +417,11 @@ Promise&#60;void&#62;
___
#### listJobs
### listJobs
`Protected **listJobs**(listConfig): Promise&#60;never[] \| [StagedJob](StagedJob.mdx)[]&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -399,7 +435,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;never[] \| [StagedJob](StagedJob.mdx)[]&#62;
@@ -417,11 +453,11 @@ Promise&#60;never[] \| [StagedJob](StagedJob.mdx)[]&#62;
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -435,7 +471,7 @@ ___
}
]} />
##### Returns
#### Returns
`boolean`
@@ -453,11 +489,11 @@ ___
___
#### startEnqueuer
### startEnqueuer
`**startEnqueuer**(): void`
##### Returns
#### Returns
`void`
@@ -475,11 +511,11 @@ ___
___
#### stopEnqueuer
### stopEnqueuer
`**stopEnqueuer**(): Promise&#60;void&#62;`
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -497,13 +533,13 @@ Promise&#60;void&#62;
___
#### subscribe
### subscribe
`**subscribe**(event, subscriber, context?): [EventBusService](EventBusService.mdx)`
Adds a function to a list of event subscribers.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -535,7 +571,7 @@ Adds a function to a list of event subscribers.
}
]} />
##### Returns
#### Returns
[EventBusService](EventBusService.mdx)
@@ -553,13 +589,13 @@ Adds a function to a list of event subscribers.
___
#### unsubscribe
### unsubscribe
`**unsubscribe**(event, subscriber, context): [EventBusService](EventBusService.mdx)`
Removes function from the list of event subscribers.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -591,7 +627,7 @@ Removes function from the list of event subscribers.
}
]} />
##### Returns
#### Returns
[EventBusService](EventBusService.mdx)
@@ -609,11 +645,11 @@ Removes function from the list of event subscribers.
___
#### withTransaction
### withTransaction
`**withTransaction**(transactionManager?): [EventBusService](EventBusService.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -627,7 +663,7 @@ ___
}
]} />
##### Returns
#### Returns
[EventBusService](EventBusService.mdx)