docs: TSDoc + reference of fulfillment service (#5761)
This commit is contained in:
@@ -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<TResult>`
|
||||
|
||||
@@ -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<TResult>
|
||||
|
||||
@@ -241,13 +277,13 @@ Promise<TResult>
|
||||
|
||||
___
|
||||
|
||||
#### emit
|
||||
### emit
|
||||
|
||||
`**emit**<TypeParameter T>(data): Promise<void \| [StagedJob](StagedJob.mdx)[]>`
|
||||
|
||||
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<void \| [StagedJob](StagedJob.mdx)[]>
|
||||
|
||||
@@ -295,7 +331,7 @@ Promise<void \| [StagedJob](StagedJob.mdx)[]>
|
||||
|
||||
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<void \| [StagedJob](StagedJob.mdx)>
|
||||
|
||||
@@ -359,11 +395,11 @@ Promise<void \| [StagedJob](StagedJob.mdx)>
|
||||
|
||||
___
|
||||
|
||||
#### enqueuer\_
|
||||
### enqueuer\_
|
||||
|
||||
`**enqueuer_**(): Promise<void>`
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -381,11 +417,11 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
#### listJobs
|
||||
### listJobs
|
||||
|
||||
`Protected **listJobs**(listConfig): Promise<never[] \| [StagedJob](StagedJob.mdx)[]>`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -399,7 +435,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<never[] \| [StagedJob](StagedJob.mdx)[]>
|
||||
|
||||
@@ -417,11 +453,11 @@ Promise<never[] \| [StagedJob](StagedJob.mdx)[]>
|
||||
|
||||
___
|
||||
|
||||
#### 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<void>`
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -497,13 +533,13 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
#### 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)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user