chore(docs): Generated Services Reference (automated) (#3465)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
a5582b93b8
commit
9ceddf45a9
@@ -19,7 +19,7 @@ subscribers when events happen. Events will run asynchronously.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:75](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L75)
|
||||
[packages/medusa/src/services/event-bus.ts:80](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L80)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -29,7 +29,7 @@ subscribers when events happen. Events will run asynchronously.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:59](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L59)
|
||||
[packages/medusa/src/services/event-bus.ts:64](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
@@ -39,7 +39,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:73](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L73)
|
||||
[packages/medusa/src/services/event-bus.ts:78](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L78)
|
||||
|
||||
___
|
||||
|
||||
@@ -49,7 +49,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:64](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L64)
|
||||
[packages/medusa/src/services/event-bus.ts:69](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
@@ -59,7 +59,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:63](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L63)
|
||||
[packages/medusa/src/services/event-bus.ts:68](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L68)
|
||||
|
||||
___
|
||||
|
||||
@@ -69,7 +69,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:61](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L61)
|
||||
[packages/medusa/src/services/event-bus.ts:66](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L66)
|
||||
|
||||
___
|
||||
|
||||
@@ -79,7 +79,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:60](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L60)
|
||||
[packages/medusa/src/services/event-bus.ts:65](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
@@ -89,7 +89,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:70](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L70)
|
||||
[packages/medusa/src/services/event-bus.ts:75](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L75)
|
||||
|
||||
___
|
||||
|
||||
@@ -99,7 +99,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:68](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L68)
|
||||
[packages/medusa/src/services/event-bus.ts:73](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L73)
|
||||
|
||||
___
|
||||
|
||||
@@ -109,7 +109,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:69](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L69)
|
||||
[packages/medusa/src/services/event-bus.ts:74](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L74)
|
||||
|
||||
___
|
||||
|
||||
@@ -119,7 +119,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:71](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L71)
|
||||
[packages/medusa/src/services/event-bus.ts:76](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
@@ -129,7 +129,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:62](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L62)
|
||||
[packages/medusa/src/services/event-bus.ts:67](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L67)
|
||||
|
||||
___
|
||||
|
||||
@@ -139,7 +139,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:72](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L72)
|
||||
[packages/medusa/src/services/event-bus.ts:77](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L77)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -177,12 +177,38 @@ void
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:421](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L421)
|
||||
[packages/medusa/src/services/event-bus.ts:463](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L463)
|
||||
|
||||
___
|
||||
|
||||
### emit
|
||||
|
||||
▸ **emit**<`T`\>(`data`): `Promise`<`void` \| `StagedJob`[]\>
|
||||
|
||||
Calls all subscribers when an event occurs.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `data` | `EmitData`<`T`\>[] | The data to use to process the events |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void` \| `StagedJob`[]\>
|
||||
|
||||
the jobs from our queue
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:228](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L228)
|
||||
|
||||
▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| `StagedJob`\>
|
||||
|
||||
Calls all subscribers when an event occurs.
|
||||
@@ -199,7 +225,7 @@ Calls all subscribers when an event occurs.
|
||||
| :------ | :------ | :------ |
|
||||
| `eventName` | `string` | the name of the event to be process. |
|
||||
| `data` | `T` | the data to send to the subscriber. |
|
||||
| `options` | `any` | options to add the job with |
|
||||
| `options?` | `any` | options to add the job with |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -209,7 +235,7 @@ the job from our queue
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:225](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L225)
|
||||
[packages/medusa/src/services/event-bus.ts:237](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L237)
|
||||
|
||||
___
|
||||
|
||||
@@ -223,7 +249,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:285](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L285)
|
||||
[packages/medusa/src/services/event-bus.ts:324](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L324)
|
||||
|
||||
___
|
||||
|
||||
@@ -237,7 +263,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:275](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L275)
|
||||
[packages/medusa/src/services/event-bus.ts:314](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L314)
|
||||
|
||||
___
|
||||
|
||||
@@ -251,7 +277,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:280](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L280)
|
||||
[packages/medusa/src/services/event-bus.ts:319](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L319)
|
||||
|
||||
___
|
||||
|
||||
@@ -277,7 +303,7 @@ this
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:155](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L155)
|
||||
[packages/medusa/src/services/event-bus.ts:160](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L160)
|
||||
|
||||
___
|
||||
|
||||
@@ -302,7 +328,7 @@ this
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:198](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L198)
|
||||
[packages/medusa/src/services/event-bus.ts:203](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L203)
|
||||
|
||||
___
|
||||
|
||||
@@ -322,7 +348,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:123](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L123)
|
||||
[packages/medusa/src/services/event-bus.ts:128](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L128)
|
||||
|
||||
___
|
||||
|
||||
@@ -352,4 +378,4 @@ resolves to the results of the subscriber calls.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:320](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/event-bus.ts#L320)
|
||||
[packages/medusa/src/services/event-bus.ts:362](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/event-bus.ts#L362)
|
||||
|
||||
Reference in New Issue
Block a user