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

chore(docs): Generated References (#5516)

Browse Source 
Generated the following references:
- `js-client`
- `pricing`
- `services`

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-02 09:16:47 +00:00
committed by GitHub
parent 80fe362f33
commit aa2bb7a31b
271 changed files with 38146 additions and 9809 deletions
Download Patch File Download Diff File Expand all files Collapse all files

183
www/apps/docs/content/references/services/classes/EventBusService.md
View File

@@ -1,4 +1,4 @@
# Class: EventBusService
# EventBusService
Can keep track of multiple subscribers to different events and run the
subscribers when events happen. Events will run asynchronously.
@@ -17,14 +17,14 @@ subscribers when events happen. Events will run asynchronously.
### constructor
• **new EventBusService**(`«destructured»`, `config`, `isSingleton?`)
**new EventBusService**(`«destructured»`, `config`, `isSingleton?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `«destructured»` | `InjectedDependencies` | `undefined` |
| `config` | `any` | `undefined` |
| Name | Default value |
| :------ | :------ |
| `«destructured»` | `InjectedDependencies` |
| `config` | `any` |
| `isSingleton` | `boolean` | `true` |
#### Overrides
@@ -33,13 +33,13 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L36)
[medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L36)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_configModule\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -47,13 +47,13 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
`Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
@@ -61,13 +61,13 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### \_\_moduleDeclaration\_\_
• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -75,53 +75,53 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
### config\_
• `Protected` `Readonly` **config\_**: `ConfigModule`
`Protected` `Readonly` **config\_**: `ConfigModule`
#### Defined in
[medusa/src/services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L27)
[medusa/src/services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L27)
___
### enqueue\_
• `Protected` **enqueue\_**: `Promise`<`void`\>
`Protected` **enqueue\_**: `Promise`<`void`\>
#### Defined in
[medusa/src/services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L34)
[medusa/src/services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L34)
___
### eventBusModuleService\_
• `Protected` `Readonly` **eventBusModuleService\_**: `IEventBusModuleService`
`Protected` `Readonly` **eventBusModuleService\_**: `IEventBusModuleService`
#### Defined in
[medusa/src/services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L30)
[medusa/src/services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L30)
___
### logger\_
• `Protected` `Readonly` **logger\_**: `Logger`
`Protected` `Readonly` **logger\_**: `Logger`
#### Defined in
[medusa/src/services/event-bus.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L31)
[medusa/src/services/event-bus.ts:31](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L31)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
`Protected` **manager\_**: `EntityManager`
#### Inherited from
@@ -129,33 +129,33 @@ TransactionBaseService.manager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
### shouldEnqueuerRun
• `Protected` **shouldEnqueuerRun**: `boolean`
`Protected` **shouldEnqueuerRun**: `boolean`
#### Defined in
[medusa/src/services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L33)
[medusa/src/services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L33)
___
### stagedJobService\_
• `Protected` `Readonly` **stagedJobService\_**: [`StagedJobService`](StagedJobService.md)
`Protected` `Readonly` **stagedJobService\_**: [`StagedJobService`](StagedJobService.md)
#### Defined in
[medusa/src/services/event-bus.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L28)
[medusa/src/services/event-bus.ts:28](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L28)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
@@ -163,47 +163,47 @@ TransactionBaseService.transactionManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
-`EntityManager`:
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
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
| Name |
| :------ |
| `TResult` |
| `TError` |
| `TResult` | `object` |
| `TError` | `object` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
@@ -212,7 +212,7 @@ transaction manager is created.
`Promise`<`TResult`\>
the result of the transactional work
-`Promise`: the result of the transactional work
#### Inherited from
@@ -220,33 +220,32 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
### emit
▸ **emit**<`T`\>(`data`): `Promise`<`void` \| `StagedJob`[]\>
**emit**<`T`\>(`data`): `Promise`<`void` \| `StagedJob`[]\>
Calls all subscribers when an event occurs.
#### Type parameters
| Name |
| :------ |
| `T` |
| `T` | `object` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `data` | `EmitData`<`T`\>[] | The data to use to process the events |
#### Returns
`Promise`<`void` \| `StagedJob`[]\>
the jobs from our queue
-`Promise`: the jobs from our queue
-`void \| StagedJob[]`: (optional)
#### Implementation of
@@ -254,31 +253,30 @@ EventBusTypes.IEventBusService.emit
#### Defined in
[medusa/src/services/event-bus.ts:117](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L117)
[medusa/src/services/event-bus.ts:117](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L117)
▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| `StagedJob`\>
**emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| `StagedJob`\>
Calls all subscribers when an event occurs.
#### Type parameters
| Name |
| :------ |
| `T` |
| `T` | `object` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `eventName` | `string` | the name of the event to be process. |
| `data` | `T` | the data to send to the subscriber. |
| `options?` | `Record`<`string`, `unknown`\> | options to add the job with |
| `options?` | Record<`string`, `unknown`\> | options to add the job with |
#### Returns
`Promise`<`void` \| `StagedJob`\>
the job from our queue
-`Promise`: the job from our queue
-`void \| StagedJob`: (optional)
#### Implementation of
@@ -286,106 +284,117 @@ EventBusTypes.IEventBusService.emit
#### Defined in
[medusa/src/services/event-bus.ts:126](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L126)
[medusa/src/services/event-bus.ts:126](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L126)
___
### enqueuer\_
▸ **enqueuer_**(): `Promise`<`void`\>
**enqueuer_**(): `Promise`<`void`\>
#### Returns
`Promise`<`void`\>
-`Promise`:
#### Defined in
[medusa/src/services/event-bus.ts:190](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L190)
[medusa/src/services/event-bus.ts:190](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L190)
___
### listJobs
▸ `Protected` **listJobs**(`listConfig`): `Promise`<`never`[] \| `StagedJob`[]\>
`Protected` **listJobs**(`listConfig`): `Promise`<`never`[] \| `StagedJob`[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `listConfig` | `FindConfig`<`StagedJob`\> |
#### Returns
`Promise`<`never`[] \| `StagedJob`[]\>
-`Promise`:
-`never[] \| StagedJob[]`: (optional)
#### Defined in
[medusa/src/services/event-bus.ts:220](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L220)
[medusa/src/services/event-bus.ts:220](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L220)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
| Name |
| :------ |
| `err` | Record<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
-`boolean`: (optional)
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
### startEnqueuer
▸ **startEnqueuer**(): `void`
**startEnqueuer**(): `void`
#### Returns
`void`
-`void`: (optional)
#### Defined in
[medusa/src/services/event-bus.ts:180](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L180)
[medusa/src/services/event-bus.ts:180](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L180)
___
### stopEnqueuer
▸ **stopEnqueuer**(): `Promise`<`void`\>
**stopEnqueuer**(): `Promise`<`void`\>
#### Returns
`Promise`<`void`\>
-`Promise`:
#### Defined in
[medusa/src/services/event-bus.ts:185](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L185)
[medusa/src/services/event-bus.ts:185](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L185)
___
### subscribe
▸ **subscribe**(`event`, `subscriber`, `context?`): [`EventBusService`](EventBusService.md)
**subscribe**(`event`, `subscriber`, `context?`): [`EventBusService`](EventBusService.md)
Adds a function to a list of event subscribers.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | 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. |
| `context?` | `SubscriberContext` | subscriber context |
@@ -394,7 +403,7 @@ Adds a function to a list of event subscribers.
[`EventBusService`](EventBusService.md)
this
-`default`: this
#### Implementation of
@@ -402,20 +411,20 @@ EventBusTypes.IEventBusService.subscribe
#### Defined in
[medusa/src/services/event-bus.ts:83](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L83)
[medusa/src/services/event-bus.ts:83](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L83)
___
### unsubscribe
▸ **unsubscribe**(`event`, `subscriber`, `context`): [`EventBusService`](EventBusService.md)
**unsubscribe**(`event`, `subscriber`, `context`): [`EventBusService`](EventBusService.md)
Removes function from the list of event subscribers.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `event` | `string` \| `symbol` | the event of the subcriber. |
| `subscriber` | `Subscriber`<`unknown`\> | the function to be removed |
| `context` | `SubscriberContext` | subscriber context |
@@ -424,7 +433,7 @@ Removes function from the list of event subscribers.
[`EventBusService`](EventBusService.md)
this
-`default`: this
#### Implementation of
@@ -432,24 +441,26 @@ EventBusTypes.IEventBusService.unsubscribe
#### Defined in
[medusa/src/services/event-bus.ts:103](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L103)
[medusa/src/services/event-bus.ts:103](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L103)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`EventBusService`](EventBusService.md)
**withTransaction**(`transactionManager?`): [`EventBusService`](EventBusService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`EventBusService`](EventBusService.md)
-`default`:
#### Implementation of
EventBusTypes.IEventBusService.withTransaction
@@ -460,4 +471,4 @@ TransactionBaseService.withTransaction
#### Defined in
[medusa/src/services/event-bus.ts:54](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/event-bus.ts#L54)
[medusa/src/services/event-bus.ts:54](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/event-bus.ts#L54)