asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated Services Reference (automated) (#2575)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-11-10 10:36:05 +02:00
committed by GitHub
parent 557352cdfe
commit 88ac804b63
51 changed files with 1286 additions and 1277 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
docs/content/references/services/classes/EventBusService.md
View File

@@ -19,7 +19,7 @@ subscribers when events happen. Events will run asynchronously.
#### Defined in
[packages/medusa/src/services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L38)
[packages/medusa/src/services/event-bus.ts:47](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L47)
## Properties
@@ -29,7 +29,7 @@ subscribers when events happen. Events will run asynchronously.
#### Defined in
[packages/medusa/src/services/event-bus.ts:24](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L24)
[packages/medusa/src/services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L33)
___
@@ -39,7 +39,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:29](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L29)
[packages/medusa/src/services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L38)
___
@@ -49,7 +49,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:32](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L32)
[packages/medusa/src/services/event-bus.ts:41](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L41)
___
@@ -59,7 +59,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L36)
[packages/medusa/src/services/event-bus.ts:45](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L45)
___
@@ -69,7 +69,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:26](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L26)
[packages/medusa/src/services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L35)
___
@@ -79,7 +79,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:25](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L25)
[packages/medusa/src/services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L34)
___
@@ -89,7 +89,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:28](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L28)
[packages/medusa/src/services/event-bus.ts:37](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L37)
___
@@ -99,7 +99,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L33)
[packages/medusa/src/services/event-bus.ts:42](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L42)
___
@@ -109,7 +109,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L30)
[packages/medusa/src/services/event-bus.ts:39](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L39)
___
@@ -119,7 +119,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:31](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L31)
[packages/medusa/src/services/event-bus.ts:40](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L40)
___
@@ -129,7 +129,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L34)
[packages/medusa/src/services/event-bus.ts:43](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L43)
___
@@ -139,7 +139,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L27)
[packages/medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L36)
___
@@ -149,7 +149,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L35)
[packages/medusa/src/services/event-bus.ts:44](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L44)
## Methods
@@ -182,7 +182,7 @@ void
#### Defined in
[packages/medusa/src/services/event-bus.ts:308](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L308)
[packages/medusa/src/services/event-bus.ts:323](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L323)
___
@@ -215,7 +215,7 @@ resolves to the results of the subscriber calls.
#### Defined in
[packages/medusa/src/services/event-bus.ts:281](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L281)
[packages/medusa/src/services/event-bus.ts:296](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L296)
___
@@ -237,8 +237,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` | `Object` | options to add the job with |
| `options.delay?` | `number` | - |
| `options` | `EmitOptions` | options to add the job with |
#### Returns
@@ -248,7 +247,7 @@ the job from our queue
#### Defined in
[packages/medusa/src/services/event-bus.ts:179](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L179)
[packages/medusa/src/services/event-bus.ts:188](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L188)
___
@@ -262,7 +261,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:215](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L215)
[packages/medusa/src/services/event-bus.ts:230](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L230)
___
@@ -287,7 +286,7 @@ this
#### Defined in
[packages/medusa/src/services/event-bus.ts:158](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L158)
[packages/medusa/src/services/event-bus.ts:167](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L167)
___
@@ -301,7 +300,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:205](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L205)
[packages/medusa/src/services/event-bus.ts:220](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L220)
___
@@ -315,7 +314,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:210](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L210)
[packages/medusa/src/services/event-bus.ts:225](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L225)
___
@@ -340,7 +339,7 @@ this
#### Defined in
[packages/medusa/src/services/event-bus.ts:118](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L118)
[packages/medusa/src/services/event-bus.ts:127](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L127)
___
@@ -365,7 +364,7 @@ this
#### Defined in
[packages/medusa/src/services/event-bus.ts:136](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L136)
[packages/medusa/src/services/event-bus.ts:145](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L145)
___
@@ -385,7 +384,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:88](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L88)
[packages/medusa/src/services/event-bus.ts:97](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L97)
___
@@ -418,4 +417,4 @@ resolves to the results of the subscriber calls.
#### Defined in
[packages/medusa/src/services/event-bus.ts:250](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/event-bus.ts#L250)
[packages/medusa/src/services/event-bus.ts:265](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/event-bus.ts#L265)