medusa-store/docs/content/references/services/classes/EventBusService.md

Class: EventBusService

Constructors

constructor

• new EventBusService(__namedParameters, config, singleton?)

Parameters

Name	Type	Default value
__namedParameters	InjectedDependencies	undefined
config	ConfigModule	undefined
singleton	boolean	true

Defined in

services/event-bus.ts:38

Properties

config_

• Protected Readonly config_: ConfigModule

Defined in

services/event-bus.ts:24

---

cronHandlers_

• Protected Readonly cronHandlers_: Map<string | symbol, Subscriber<unknown>[]>

Defined in

services/event-bus.ts:29

---

cronQueue_

• Protected Readonly cronQueue_: Bull

Defined in

services/event-bus.ts:32

---

enqueue_

• Protected enqueue_: Promise<void>

Defined in

services/event-bus.ts:36

---

logger_

• Protected Readonly logger_: Logger

Defined in

services/event-bus.ts:26

---

manager_

• Protected Readonly manager_: EntityManager

Defined in

services/event-bus.ts:25

---

observers_

• Protected Readonly observers_: Map<string | symbol, Subscriber<unknown>[]>

Defined in

services/event-bus.ts:28

---

queue_

• Protected queue_: Bull

Defined in

services/event-bus.ts:33

---

redisClient_

• Protected Readonly redisClient_: Redis

Defined in

services/event-bus.ts:30

---

redisSubscriber_

• Protected Readonly redisSubscriber_: Redis

Defined in

services/event-bus.ts:31

---

shouldEnqueuerRun

• Protected shouldEnqueuerRun: boolean

Defined in

services/event-bus.ts:34

---

stagedJobRepository_

• Protected Readonly stagedJobRepository_: typeof StagedJobRepository

Defined in

services/event-bus.ts:27

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Defined in

services/event-bus.ts:35

Methods

createCronJob

▸ createCronJob<T>(eventName, data, cron, handler): void

Type parameters

Name
T

Parameters

Name	Type	Description
eventName	string
data	T
cron	string
handler	Subscriber<unknown>

Returns

void

Defined in

services/event-bus.ts:308

---

cronWorker_

▸ cronWorker_<T>(job): Promise<unknown[]>

Type parameters

Name
T

Parameters

Name	Type	Description
job	Object
job.data	Object	-
job.data.data	T	-
job.data.eventName	string	-

Returns

Promise<unknown[]>

Defined in

services/event-bus.ts:281

---

emit

▸ emit<T>(eventName, data, options?): Promise<void | StagedJob>

Type parameters

Name
T

Parameters

Name	Type	Description
eventName	string
data	T
options	Object
options.delay?	number	-

Returns

Promise<void | StagedJob>

Defined in

services/event-bus.ts:179

---

enqueuer_

▸ enqueuer_(): Promise<void>

Returns

Promise<void>

Defined in

services/event-bus.ts:215

---

registerCronHandler_

▸ Protected registerCronHandler_(event, subscriber): EventBusService

Parameters

Name	Type	Description
event	string | symbol
subscriber	Subscriber<unknown>

Returns

EventBusService

Defined in

services/event-bus.ts:158

---

startEnqueuer

▸ startEnqueuer(): void

Returns

void

Defined in

services/event-bus.ts:205

---

stopEnqueuer

▸ stopEnqueuer(): Promise<void>

Returns

Promise<void>

Defined in

services/event-bus.ts:210

---

subscribe

▸ subscribe(event, subscriber): EventBusService

Parameters

Name	Type	Description
event	string | symbol
subscriber	Subscriber<unknown>

Returns

EventBusService

Defined in

services/event-bus.ts:118

---

unsubscribe

▸ unsubscribe(event, subscriber): EventBusService

Parameters

Name	Type	Description
event	string | symbol
subscriber	Subscriber<unknown>

Returns

EventBusService

Defined in

services/event-bus.ts:136

---

withTransaction

▸ withTransaction(transactionManager): EventBusService

Parameters

Name	Type
transactionManager	any

Returns

EventBusService

Defined in

services/event-bus.ts:88

---

worker_

▸ worker_<T>(job): Promise<unknown[]>

Type parameters

Name
T

Parameters

Name	Type	Description
job	Object
job.data	Object	-
job.data.data	T	-
job.data.eventName	string	-

Returns

Promise<unknown[]>

Defined in

services/event-bus.ts:250