chore(docs): Generated References (#5743)
Generated the following references: - `entities` - `inventory` - `js-client` - `pricing` - `product` - `services` - `stock-location` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
dc6b815b12
commit
cdd42dbdcd
@@ -15,11 +15,11 @@ subscribers when events happen. Events will run asynchronously.
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
#### constructor
|
||||
|
||||
`**new EventBusService**(«destructured», config, isSingleton?)`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -148,51 +148,19 @@ subscribers when events happen. Events will run asynchronously.
|
||||
|
||||
## Accessors
|
||||
|
||||
### activeManager\_
|
||||
#### activeManager\_
|
||||
|
||||
`Protected get**activeManager_**(): EntityManager`
|
||||
|
||||
#### Returns
|
||||
|
||||
EntityManager
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "EntityManager",
|
||||
"type": "EntityManager",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
`Protected` **activeManager\_**: [object Object]
|
||||
|
||||
___
|
||||
|
||||
### eventBusModuleService\_
|
||||
#### eventBusModuleService\_
|
||||
|
||||
`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": []
|
||||
}
|
||||
]} />
|
||||
`Protected` **eventBusModuleService\_**: [object Object]
|
||||
|
||||
## Methods
|
||||
|
||||
### atomicPhase\_
|
||||
#### atomicPhase\_
|
||||
|
||||
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>`
|
||||
|
||||
@@ -200,6 +168,8 @@ 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
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TResult",
|
||||
@@ -221,7 +191,7 @@ transaction manager is created.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -253,7 +223,7 @@ transaction manager is created.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<TResult>
|
||||
|
||||
@@ -271,12 +241,14 @@ Promise<TResult>
|
||||
|
||||
___
|
||||
|
||||
### emit
|
||||
#### emit
|
||||
|
||||
`**emit**<TypeParameter T>(data): Promise<void \| [StagedJob](StagedJob.mdx)[]>`
|
||||
|
||||
Calls all subscribers when an event occurs.
|
||||
|
||||
##### Type Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
@@ -289,7 +261,7 @@ Calls all subscribers when an event occurs.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -303,7 +275,7 @@ Calls all subscribers when an event occurs.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<void \| [StagedJob](StagedJob.mdx)[]>
|
||||
|
||||
@@ -323,6 +295,8 @@ Promise<void \| [StagedJob](StagedJob.mdx)[]>
|
||||
|
||||
Calls all subscribers when an event occurs.
|
||||
|
||||
##### Type Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
@@ -335,7 +309,7 @@ Calls all subscribers when an event occurs.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -367,7 +341,7 @@ Calls all subscribers when an event occurs.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<void \| [StagedJob](StagedJob.mdx)>
|
||||
|
||||
@@ -385,11 +359,11 @@ Promise<void \| [StagedJob](StagedJob.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### enqueuer\_
|
||||
#### enqueuer\_
|
||||
|
||||
`**enqueuer_**(): Promise<void>`
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -407,11 +381,11 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
### listJobs
|
||||
#### listJobs
|
||||
|
||||
`Protected **listJobs**(listConfig): Promise<never[] \| [StagedJob](StagedJob.mdx)[]>`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -425,7 +399,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<never[] \| [StagedJob](StagedJob.mdx)[]>
|
||||
|
||||
@@ -443,11 +417,11 @@ Promise<never[] \| [StagedJob](StagedJob.mdx)[]>
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
#### shouldRetryTransaction\_
|
||||
|
||||
`Protected **shouldRetryTransaction_**(err): boolean`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -461,7 +435,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
@@ -479,11 +453,11 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### startEnqueuer
|
||||
#### startEnqueuer
|
||||
|
||||
`**startEnqueuer**(): void`
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`void`
|
||||
|
||||
@@ -501,11 +475,11 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### stopEnqueuer
|
||||
#### stopEnqueuer
|
||||
|
||||
`**stopEnqueuer**(): Promise<void>`
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -523,13 +497,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={[
|
||||
{
|
||||
@@ -561,7 +535,7 @@ Adds a function to a list of event subscribers.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
[EventBusService](EventBusService.mdx)
|
||||
|
||||
@@ -579,13 +553,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={[
|
||||
{
|
||||
@@ -617,7 +591,7 @@ Removes function from the list of event subscribers.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
[EventBusService](EventBusService.mdx)
|
||||
|
||||
@@ -635,11 +609,11 @@ Removes function from the list of event subscribers.
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
#### withTransaction
|
||||
|
||||
`**withTransaction**(transactionManager?): [EventBusService](EventBusService.mdx)`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -653,7 +627,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
[EventBusService](EventBusService.mdx)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user