docs: TSDoc + reference of fulfillment service (#5761)
This commit is contained in:
@@ -10,12 +10,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
- [IEventBusModuleService](../interfaces/IEventBusModuleService.mdx)
|
||||
|
||||
## Constructors
|
||||
|
||||
#### constructor
|
||||
## constructor
|
||||
|
||||
`**new AbstractEventBusModuleService**()`
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
@@ -30,19 +30,39 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
## Accessors
|
||||
|
||||
#### eventToSubscribersMap
|
||||
### eventToSubscribersMap
|
||||
|
||||
**eventToSubscribersMap**: [object Object]
|
||||
`get**eventToSubscribersMap**(): Map<string \| symbol, [SubscriberDescriptor](../types/SubscriberDescriptor.mdx)[]>`
|
||||
|
||||
#### Returns
|
||||
|
||||
Map<string \| symbol, [SubscriberDescriptor](../types/SubscriberDescriptor.mdx)[]>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Map",
|
||||
"type": "Map<string \\| symbol, [SubscriberDescriptor](../types/SubscriberDescriptor.mdx)[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
#### emit
|
||||
### emit
|
||||
|
||||
`Abstract **emit**<TypeParameter T>(eventName, data, options): Promise<void>`
|
||||
|
||||
##### Type Parameters
|
||||
#### Type Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -56,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -88,7 +108,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -106,7 +126,7 @@ Promise<void>
|
||||
|
||||
`Abstract **emit**<TypeParameter T>(data): Promise<void>`
|
||||
|
||||
##### Type Parameters
|
||||
#### Type Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -120,7 +140,7 @@ Promise<void>
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -134,7 +154,7 @@ Promise<void>
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -152,11 +172,11 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
#### storeSubscribers
|
||||
### storeSubscribers
|
||||
|
||||
`Protected **storeSubscribers**(«destructured»): void`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -197,7 +217,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
@@ -215,11 +235,11 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### subscribe
|
||||
### subscribe
|
||||
|
||||
`**subscribe**(eventName, subscriber, context?): [AbstractEventBusModuleService](AbstractEventBusModuleService.mdx)`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -251,7 +271,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
[AbstractEventBusModuleService](AbstractEventBusModuleService.mdx)
|
||||
|
||||
@@ -269,11 +289,11 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### unsubscribe
|
||||
### unsubscribe
|
||||
|
||||
`**unsubscribe**(eventName, subscriber, context): [AbstractEventBusModuleService](AbstractEventBusModuleService.mdx)`
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -305,7 +325,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
[AbstractEventBusModuleService](AbstractEventBusModuleService.mdx)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user