Skip to main content

AsyncEventEmitter

@webda/core

Interface: AsyncEventEmitter<E>

Defined in: packages/core/src/events/asynceventemitter.ts:14

Similar to EventEmitter but emit returns a Promise so you can decide to wait for the event to be processed or not

Type Parameters​

E​

E extends AsyncEventUnknown = AsyncEventUnknown

Methods​

addListener()​

addListener<Key>(event, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:20

EventEmitter interface

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

event​

Key

listener​

(event) => void | Promise<void>

Returns​

this

emit()​

emit<Key>(eventName, event): Promise<void>

Defined in: packages/core/src/events/asynceventemitter.ts:57

Emit an event for this class

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName​

keyof E

event​

E[Key]

Returns​

Promise<void>

getMaxListeners()​

getMaxListeners(): number

Defined in: packages/core/src/events/asynceventemitter.ts:70

Returns​

number

listeners()​

listeners(eventName): Function[]

Defined in: packages/core/src/events/asynceventemitter.ts:62

Parameters​

eventName​

keyof E

Returns​

Function[]

off()​

off<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:44

EventEmitter interface

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName​

Key

listener​

(event) => void | Promise<void>

Returns​

this

on()​

on<Key>(event, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:32

EventEmitter interface

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

event​

Key

listener​

(event) => void | Promise<void>

Returns​

this

once()​

once<Key>(event, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:26

EventEmitter interface

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

event​

Key

listener​

(event) => void | Promise<void>

Returns​

this

removeAllListeners()​

removeAllListeners(eventName?): this

Defined in: packages/core/src/events/asynceventemitter.ts:50

EventEmitter interface

Parameters​

eventName?​

keyof E

Returns​

this

removeListener()​

removeListener<Key>(event, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:38

EventEmitter interface

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

event​

Key

listener​

(event) => void | Promise<void>

Returns​

this

setMaxListeners()​

setMaxListeners(n): this

Defined in: packages/core/src/events/asynceventemitter.ts:66

Parameters​

n​

number

Returns​

this