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

docs: update Typedoc and regenerate references (#1994)

Browse Source 
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
This commit is contained in:
Shahed Nasser
2022-08-04 17:29:52 +03:00
committed by GitHub
parent 6663a6290b
commit 02d5c1da88
630 changed files with 21256 additions and 16381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,5 +1,8 @@
# Class: EventBusService
Can keep track of multiple subscribers to different events and run the
subscribers when events happen. Events will run asynchronously.
## Constructors
### constructor
@@ -16,7 +19,7 @@
#### Defined in
[services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L38)
[packages/medusa/src/services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L38)
## Properties
@@ -26,7 +29,7 @@
#### Defined in
[services/event-bus.ts:24](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L24)
[packages/medusa/src/services/event-bus.ts:24](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L24)
___
@@ -36,7 +39,7 @@ ___
#### Defined in
[services/event-bus.ts:29](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L29)
[packages/medusa/src/services/event-bus.ts:29](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L29)
___
@@ -46,7 +49,7 @@ ___
#### Defined in
[services/event-bus.ts:32](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L32)
[packages/medusa/src/services/event-bus.ts:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L32)
___
@@ -56,7 +59,7 @@ ___
#### Defined in
[services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L36)
[packages/medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L36)
___
@@ -66,7 +69,7 @@ ___
#### Defined in
[services/event-bus.ts:26](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L26)
[packages/medusa/src/services/event-bus.ts:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L26)
___
@@ -76,7 +79,7 @@ ___
#### Defined in
[services/event-bus.ts:25](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L25)
[packages/medusa/src/services/event-bus.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L25)
___
@@ -86,7 +89,7 @@ ___
#### Defined in
[services/event-bus.ts:28](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L28)
[packages/medusa/src/services/event-bus.ts:28](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L28)
___
@@ -96,7 +99,7 @@ ___
#### Defined in
[services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L33)
[packages/medusa/src/services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L33)
___
@@ -106,7 +109,7 @@ ___
#### Defined in
[services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L30)
[packages/medusa/src/services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L30)
___
@@ -116,7 +119,7 @@ ___
#### Defined in
[services/event-bus.ts:31](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L31)
[packages/medusa/src/services/event-bus.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L31)
___
@@ -126,7 +129,7 @@ ___
#### Defined in
[services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L34)
[packages/medusa/src/services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L34)
___
@@ -136,7 +139,7 @@ ___
#### Defined in
[services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L27)
[packages/medusa/src/services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L27)
___
@@ -146,7 +149,7 @@ ___
#### Defined in
[services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L35)
[packages/medusa/src/services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L35)
## Methods
@@ -154,6 +157,8 @@ ___
▸ **createCronJob**<`T`\>(`eventName`, `data`, `cron`, `handler`): `void`
Registers a cron job.
#### Type parameters
| Name |
@@ -164,18 +169,20 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `eventName` | `string` | |
| `data` | `T` | |
| `cron` | `string` | |
| `handler` | `Subscriber`<`unknown`\> | |
| `eventName` | `string` | the name of the event |
| `data` | `T` | the data to be sent with the event |
| `cron` | `string` | the cron pattern |
| `handler` | `Subscriber`<`unknown`\> | the handler to call on each cron job |
#### Returns
`void`
void
#### Defined in
[services/event-bus.ts:308](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L308)
[packages/medusa/src/services/event-bus.ts:308](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L308)
___
@@ -183,6 +190,8 @@ ___
▸ **cronWorker_**<`T`\>(`job`): `Promise`<`unknown`[]\>
Handles incoming jobs.
#### Type parameters
| Name |
@@ -193,7 +202,7 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `job` | `Object` | |
| `job` | `Object` | The job object |
| `job.data` | `Object` | - |
| `job.data.data` | `T` | - |
| `job.data.eventName` | `string` | - |
@@ -202,9 +211,11 @@ ___
`Promise`<`unknown`[]\>
resolves to the results of the subscriber calls.
#### Defined in
[services/event-bus.ts:281](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L281)
[packages/medusa/src/services/event-bus.ts:281](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L281)
___
@@ -212,6 +223,8 @@ ___
▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| `StagedJob`\>
Calls all subscribers when an event occurs.
#### Type parameters
| Name |
@@ -222,18 +235,20 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `eventName` | `string` | |
| `data` | `T` | |
| `options` | `Object` | |
| `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` | - |
#### Returns
`Promise`<`void` \| `StagedJob`\>
the job from our queue
#### Defined in
[services/event-bus.ts:179](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L179)
[packages/medusa/src/services/event-bus.ts:179](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L179)
___
@@ -247,7 +262,7 @@ ___
#### Defined in
[services/event-bus.ts:215](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L215)
[packages/medusa/src/services/event-bus.ts:215](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L215)
___
@@ -255,20 +270,24 @@ ___
▸ `Protected` **registerCronHandler_**(`event`, `subscriber`): [`EventBusService`](EventBusService.md)
Adds a function to a list of event subscribers.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `event` | `string` \| `symbol` | |
| `subscriber` | `Subscriber`<`unknown`\> | |
| `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. |
#### Returns
[`EventBusService`](EventBusService.md)
this
#### Defined in
[services/event-bus.ts:158](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L158)
[packages/medusa/src/services/event-bus.ts:158](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L158)
___
@@ -282,7 +301,7 @@ ___
#### Defined in
[services/event-bus.ts:205](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L205)
[packages/medusa/src/services/event-bus.ts:205](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L205)
___
@@ -296,7 +315,7 @@ ___
#### Defined in
[services/event-bus.ts:210](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L210)
[packages/medusa/src/services/event-bus.ts:210](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L210)
___
@@ -304,20 +323,24 @@ ___
▸ **subscribe**(`event`, `subscriber`): [`EventBusService`](EventBusService.md)
Adds a function to a list of event subscribers.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `event` | `string` \| `symbol` | |
| `subscriber` | `Subscriber`<`unknown`\> | |
| `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. |
#### Returns
[`EventBusService`](EventBusService.md)
this
#### Defined in
[services/event-bus.ts:118](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L118)
[packages/medusa/src/services/event-bus.ts:118](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L118)
___
@@ -325,20 +348,24 @@ ___
▸ **unsubscribe**(`event`, `subscriber`): [`EventBusService`](EventBusService.md)
Adds a function to a list of event subscribers.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `event` | `string` \| `symbol` | |
| `subscriber` | `Subscriber`<`unknown`\> | |
| `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. |
#### Returns
[`EventBusService`](EventBusService.md)
this
#### Defined in
[services/event-bus.ts:136](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L136)
[packages/medusa/src/services/event-bus.ts:136](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L136)
___
@@ -358,7 +385,7 @@ ___
#### Defined in
[services/event-bus.ts:88](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L88)
[packages/medusa/src/services/event-bus.ts:88](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L88)
___
@@ -366,6 +393,8 @@ ___
▸ **worker_**<`T`\>(`job`): `Promise`<`unknown`[]\>
Handles incoming jobs.
#### Type parameters
| Name |
@@ -376,7 +405,7 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `job` | `Object` | |
| `job` | `Object` | The job object |
| `job.data` | `Object` | - |
| `job.data.data` | `T` | - |
| `job.data.eventName` | `string` | - |
@@ -385,6 +414,8 @@ ___
`Promise`<`unknown`[]\>
resolves to the results of the subscriber calls.
#### Defined in
[services/event-bus.ts:250](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L250)
[packages/medusa/src/services/event-bus.ts:250](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L250)