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:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions

View File

@@ -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&#60;TResult&#62;`
@@ -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&#60;TResult&#62;
@@ -271,12 +241,14 @@ 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
<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&#60;void \| [StagedJob](StagedJob.mdx)[]&#62;
@@ -323,6 +295,8 @@ Promise&#60;void \| [StagedJob](StagedJob.mdx)[]&#62;
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&#60;void \| [StagedJob](StagedJob.mdx)&#62;
@@ -385,11 +359,11 @@ Promise&#60;void \| [StagedJob](StagedJob.mdx)&#62;
___
### enqueuer\_
#### enqueuer\_
`**enqueuer_**(): Promise&#60;void&#62;`
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -407,11 +381,11 @@ Promise&#60;void&#62;
___
### listJobs
#### listJobs
`Protected **listJobs**(listConfig): Promise&#60;never[] \| [StagedJob](StagedJob.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -425,7 +399,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;never[] \| [StagedJob](StagedJob.mdx)[]&#62;
@@ -443,11 +417,11 @@ Promise&#60;never[] \| [StagedJob](StagedJob.mdx)[]&#62;
___
### 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&#60;void&#62;`
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -523,13 +497,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={[
{
@@ -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)