Skip to content

Latest commit

 

History

History
233 lines (136 loc) · 3.36 KB

EventBus.md

File metadata and controls

233 lines (136 loc) · 3.36 KB

RedisSMQ / Docs / API Reference / EventBus

Class: EventBus

Hierarchy

  • EventEmitter<Pick<TRedisClientEvent, "error">>

    EventBus

Table of contents

Constructors

Methods

Constructors

constructor

new EventBus(): EventBus

Returns

EventBus

Inherited from

EventEmitter<Pick<TRedisClientEvent, 'error'>>.constructor

Methods

emit

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

Type parameters

Name Type
E extends "error"

Parameters

Name Type
event E
...args Parameters<Pick<TRedisClientEvent, "error">[E]>

Returns

boolean

Inherited from

EventEmitter.emit


getInstance

getInstance(): Error | IEventBus<TRedisSMQEvent>

Returns

Error | IEventBus<TRedisSMQEvent>


getSetInstance

getSetInstance(cb): void

Parameters

Name Type
cb ICallback<IEventBus<TRedisSMQEvent>>

Returns

void


init

init(cb): void

Parameters

Name Type
cb ICallback<void>

Returns

void


on

on<E>(event, listener): this

Type parameters

Name Type
E extends "error"

Parameters

Name Type
event E
listener Pick<TRedisClientEvent, "error">[E]

Returns

this

Inherited from

EventEmitter.on


once

once<E>(event, listener): this

Type parameters

Name Type
E extends "error"

Parameters

Name Type
event E
listener Pick<TRedisClientEvent, "error">[E]

Returns

this

Inherited from

EventEmitter.once


removeAllListeners

removeAllListeners<E>(event?): this

Type parameters

Name Type
E extends "error"

Parameters

Name Type
event? Extract<E, string>

Returns

this

Inherited from

EventEmitter.removeAllListeners


removeListener

removeListener<E>(event, listener): this

Type parameters

Name Type
E extends "error"

Parameters

Name Type
event E
listener Pick<TRedisClientEvent, "error">[E]

Returns

this

Inherited from

EventEmitter.removeListener


shutdown

shutdown(cb): void

Parameters

Name Type
cb ICallback<void>

Returns

void