EventBus.md

RedisSMQ Common Library / Docs / API Reference / EventBus

Class: EventBus<Events>

Type parameters

Name	Type
Events	extends TEventBusEvent

Hierarchy

• EventEmitter<Events>

  ↳ EventBus

Implements

• IEventBus<Events>

Table of contents

Methods

• emit
• on
• once
• removeAllListeners
• removeListener
• shutdown
• createInstance

Methods

emit

▸ emit<E>(event, ...args): boolean

Type parameters

Name	Type
E	extends string | number | symbol

Parameters

Name	Type
event	E
...args	Parameters<Events[E]>

Returns

boolean

Implementation of

IEventBus.emit

Overrides

EventEmitter.emit

---

on

▸ on<E>(event, listener): this

Type parameters

Name	Type
E	extends string | number | symbol

Parameters

Name	Type
event	E
listener	Events[E]

Returns

this

Implementation of

IEventBus.on

Overrides

EventEmitter.on

---

once

▸ once<E>(event, listener): this

Type parameters

Name	Type
E	extends string | number | symbol

Parameters

Name	Type
event	E
listener	Events[E]

Returns

this

Implementation of

IEventBus.once

Overrides

EventEmitter.once

---

removeAllListeners

▸ removeAllListeners<E>(event?): this

Type parameters

Name	Type
E	extends string | number | symbol

Parameters

Name	Type
event?	Extract<E, string>

Returns

this

Implementation of

IEventBus.removeAllListeners

Overrides

EventEmitter.removeAllListeners

---

removeListener

▸ removeListener<E>(event, listener): this

Type parameters

Name	Type
E	extends string | number | symbol

Parameters

Name	Type
event	E
listener	Events[E]

Returns

this

Implementation of

IEventBus.removeListener

Overrides

EventEmitter.removeListener

---

shutdown

▸ shutdown(cb): void

Parameters

Name	Type
cb	ICallback<void>

Returns

void

Implementation of

IEventBus.shutdown

---

createInstance

▸ createInstance<T>(cb): void

Type parameters

Name	Type
T	extends TEventBusEvent

Parameters

Name	Type
cb	ICallback<IEventBus<T>>

Returns

void