chore(docs): Generated Services Reference (automated) (#2993)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
6dafb51547
commit
f521260a8f
@@ -19,7 +19,7 @@ subscribers when events happen. Events will run asynchronously.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L48)
|
||||
[packages/medusa/src/services/event-bus.ts:73](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L73)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -29,7 +29,7 @@ subscribers when events happen. Events will run asynchronously.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L35)
|
||||
[packages/medusa/src/services/event-bus.ts:57](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
@@ -39,7 +39,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L46)
|
||||
[packages/medusa/src/services/event-bus.ts:71](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
### eventToSubscribersMap\_
|
||||
|
||||
• `Protected` `Readonly` **eventToSubscribersMap\_**: `Map`<`string` \| `symbol`, `SubscriberDescriptor`[]\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:62](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
@@ -49,7 +59,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L39)
|
||||
[packages/medusa/src/services/event-bus.ts:61](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
@@ -59,7 +69,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L37)
|
||||
[packages/medusa/src/services/event-bus.ts:59](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
@@ -69,17 +79,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
### observers\_
|
||||
|
||||
• `Protected` `Readonly` **observers\_**: `Map`<`string` \| `symbol`, `Subscriber`<`unknown`\>[]\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L40)
|
||||
[packages/medusa/src/services/event-bus.ts:58](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -89,7 +89,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L43)
|
||||
[packages/medusa/src/services/event-bus.ts:68](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L68)
|
||||
|
||||
___
|
||||
|
||||
@@ -99,7 +99,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L41)
|
||||
[packages/medusa/src/services/event-bus.ts:66](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L66)
|
||||
|
||||
___
|
||||
|
||||
@@ -109,7 +109,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L42)
|
||||
[packages/medusa/src/services/event-bus.ts:67](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L67)
|
||||
|
||||
___
|
||||
|
||||
@@ -119,7 +119,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L44)
|
||||
[packages/medusa/src/services/event-bus.ts:69](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
@@ -129,7 +129,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L38)
|
||||
[packages/medusa/src/services/event-bus.ts:60](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
@@ -139,7 +139,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L45)
|
||||
[packages/medusa/src/services/event-bus.ts:70](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L70)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -176,7 +176,7 @@ void
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:279](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L279)
|
||||
[packages/medusa/src/services/event-bus.ts:416](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L416)
|
||||
|
||||
___
|
||||
|
||||
@@ -198,7 +198,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` | `EmitOptions` | options to add the job with |
|
||||
| `options` | `Record`<`string`, `unknown`\> & `EmitOptions` | options to add the job with |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -208,7 +208,7 @@ the job from our queue
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:167](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L167)
|
||||
[packages/medusa/src/services/event-bus.ts:223](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L223)
|
||||
|
||||
___
|
||||
|
||||
@@ -222,7 +222,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:209](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L209)
|
||||
[packages/medusa/src/services/event-bus.ts:280](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L280)
|
||||
|
||||
___
|
||||
|
||||
@@ -236,7 +236,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:199](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L199)
|
||||
[packages/medusa/src/services/event-bus.ts:270](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L270)
|
||||
|
||||
___
|
||||
|
||||
@@ -250,13 +250,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:204](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L204)
|
||||
[packages/medusa/src/services/event-bus.ts:275](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L275)
|
||||
|
||||
___
|
||||
|
||||
### subscribe
|
||||
|
||||
▸ **subscribe**(`event`, `subscriber`): [`EventBusService`](EventBusService.md)
|
||||
▸ **subscribe**(`event`, `subscriber`, `context?`): [`EventBusService`](EventBusService.md)
|
||||
|
||||
Adds a function to a list of event subscribers.
|
||||
|
||||
@@ -265,7 +265,8 @@ Adds a function to a list of event subscribers.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `event` | `string` \| `symbol` | the event that the subscriber will listen for. |
|
||||
| `subscriber` | `Subscriber`<`unknown`\> | the function to be called when a certain event happens. Subscribers must return a Promise. |
|
||||
| `subscriber` | `Subscriber`<`unknown`\> | the function to be called when a certain event |
|
||||
| `context?` | `SubscriberContext` | context to use when attaching subscriber happens. Subscribers must return a Promise. |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -275,7 +276,7 @@ this
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:127](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L127)
|
||||
[packages/medusa/src/services/event-bus.ts:153](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L153)
|
||||
|
||||
___
|
||||
|
||||
@@ -300,7 +301,7 @@ this
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:145](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L145)
|
||||
[packages/medusa/src/services/event-bus.ts:196](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L196)
|
||||
|
||||
___
|
||||
|
||||
@@ -320,13 +321,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:96](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L96)
|
||||
[packages/medusa/src/services/event-bus.ts:121](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L121)
|
||||
|
||||
___
|
||||
|
||||
### worker\_
|
||||
|
||||
▸ **worker_**<`T`\>(`job`): `Promise`<`unknown`[]\>
|
||||
▸ **worker_**<`T`\>(`job`): `Promise`<`unknown`\>
|
||||
|
||||
Handles incoming jobs.
|
||||
|
||||
@@ -340,17 +341,14 @@ Handles incoming jobs.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `job` | `Object` | The job object |
|
||||
| `job.data` | `Object` | - |
|
||||
| `job.data.data` | `T` | - |
|
||||
| `job.data.eventName` | `string` | - |
|
||||
| `job` | `BullJob`<`T`\> | The job object |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`unknown`[]\>
|
||||
`Promise`<`unknown`\>
|
||||
|
||||
resolves to the results of the subscriber calls.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:244](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L244)
|
||||
[packages/medusa/src/services/event-bus.ts:315](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/event-bus.ts#L315)
|
||||
|
||||
Reference in New Issue
Block a user