EventBusService
Can keep track of multiple subscribers to different events and run the subscribers when events happen. Events will run asynchronously.
Hierarchy
TransactionBaseService↳
EventBusService
Implements
IEventBusService
Constructors
constructor
new EventBusService(«destructured», config, isSingleton?)
Parameters
| Name | Default value |
|---|---|
«destructured» | InjectedDependencies |
config | any |
isSingleton | boolean |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/event-bus.ts:36
Properties
__configModule__
Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.__configModule__
Defined in
medusa/src/interfaces/transaction-base-service.ts:14
__container__
Protected Readonly __container__: any
Inherited from
TransactionBaseService.__container__
Defined in
medusa/src/interfaces/transaction-base-service.ts:13
__moduleDeclaration__
Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
medusa/src/interfaces/transaction-base-service.ts:15
config_
Protected Readonly config_: ConfigModule
Defined in
medusa/src/services/event-bus.ts:27
enqueue_
Protected enqueue_: Promise<void>
Defined in
medusa/src/services/event-bus.ts:34
eventBusModuleService_
Protected Readonly eventBusModuleService_: IEventBusModuleService
Defined in
medusa/src/services/event-bus.ts:30
logger_
Protected Readonly logger_: Logger
Defined in
medusa/src/services/event-bus.ts:31
manager_
Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
shouldEnqueuerRun
Protected shouldEnqueuerRun: boolean
Defined in
medusa/src/services/event-bus.ts:33
stagedJobService_
Protected Readonly stagedJobService_: StagedJobService
Defined in
medusa/src/services/event-bus.ts:28
transactionManager_
Protected transactionManager_: undefined | EntityManager
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
Accessors
activeManager_
Protected get activeManager_(): EntityManager
Returns
EntityManager
-EntityManager:
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
Methods
atomicPhase_
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.
| Name |
|---|
TResult |
TError |
Parameters
| Name | Description |
|---|---|
work | (transactionManager: EntityManager) => Promise<TResult> |
isolationOrErrorHandler? | IsolationLevel | (error: TError) => Promise<void | TResult> |
maybeErrorHandlerOrDontFail? | (error: TError) => Promise<void | TResult> |
Returns
Promise<TResult>
-Promise: the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
medusa/src/interfaces/transaction-base-service.ts:56
emit
emit<T>(data): Promise<void | StagedJob[]>
Calls all subscribers when an event occurs.
| Name |
|---|
T |
Parameters
| Name | Description |
|---|---|
data | EmitData<T>[] |
Returns
Promise<void | StagedJob[]>
-Promise: the jobs from our queue
-void \| StagedJob[]: (optional)
Implementation of
EventBusTypes.IEventBusService.emit
Defined in
medusa/src/services/event-bus.ts:117
emit<T>(eventName, data, options?): Promise<void | StagedJob>
Calls all subscribers when an event occurs.
| Name |
|---|
T |
Parameters
| Name | Description |
|---|---|
eventName | string |
data | T |
options? | Record<string, unknown> |
Returns
Promise<void | StagedJob>
-Promise: the job from our queue
-void \| StagedJob: (optional)
Implementation of
EventBusTypes.IEventBusService.emit
Defined in
medusa/src/services/event-bus.ts:126
enqueuer_
enqueuer_(): Promise<void>
Returns
Promise<void>
-Promise:
Defined in
medusa/src/services/event-bus.ts:190
listJobs
Protected listJobs(listConfig): Promise<never[] | StagedJob[]>
Parameters
| Name |
|---|
listConfig |
Returns
Promise<never[] | StagedJob[]>
-Promise:
-never[] \| StagedJob[]: (optional)
Defined in
medusa/src/services/event-bus.ts:220
shouldRetryTransaction_
Protected shouldRetryTransaction_(err): boolean
Parameters
| Name |
|---|
err |
Returns
boolean
-boolean: (optional)
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
startEnqueuer
startEnqueuer(): void
Returns
void
-void: (optional)
Defined in
medusa/src/services/event-bus.ts:180
stopEnqueuer
stopEnqueuer(): Promise<void>
Returns
Promise<void>
-Promise:
Defined in
medusa/src/services/event-bus.ts:185
subscribe
subscribe(event, subscriber, context?): EventBusService
Adds a function to a list of event subscribers.
Parameters
| Name | Description |
|---|---|
event | string | symbol |
subscriber | Subscriber<unknown> |
context? | SubscriberContext |
Returns
-default: this
Implementation of
EventBusTypes.IEventBusService.subscribe
Defined in
medusa/src/services/event-bus.ts:83
unsubscribe
unsubscribe(event, subscriber, context): EventBusService
Removes function from the list of event subscribers.
Parameters
| Name | Description |
|---|---|
event | string | symbol |
subscriber | Subscriber<unknown> |
context | SubscriberContext |
Returns
-default: this
Implementation of
EventBusTypes.IEventBusService.unsubscribe
Defined in
medusa/src/services/event-bus.ts:103
withTransaction
withTransaction(transactionManager?): EventBusService
Parameters
| Name |
|---|
transactionManager? |
Returns
-default:
Implementation of
EventBusTypes.IEventBusService.withTransaction
Overrides
TransactionBaseService.withTransaction