Skip to main content

AsyncEventEmitterImpl

@webda/core

Class: AsyncEventEmitterImpl<E>

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

Concrete implementation of AsyncEventEmitter that wraps Node.js EventEmitter with async support

Extended by​

Type Parameters​

E​

E extends AsyncEventUnknown = AsyncEventUnknown

Implements​

Constructors​

Constructor​

protected new AsyncEventEmitterImpl<E>(): AsyncEventEmitterImpl<E>

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

Constructor

Returns​

AsyncEventEmitterImpl<E>

Methods​

addListener()​

addListener<Key>(eventName, listener): this

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

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName​

Key

the event name

listener​

(event) => void | Promise<void>

the event listener

Returns​

this

this for chaining

See​

EventEmitter.addListener

Implementation of​

AsyncEventEmitter.addListener

emit()​

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

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

Emit an event for this class

Instead of returning a boolean, this method returns a Promise so you can decide to wait for the event to be processed or not

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName​

Key

the event name

event​

E[Key]

the event name

Returns​

Promise<void>

See​

EventEmitter.emit

Implementation of​

AsyncEventEmitter.emit

getMaxListeners()​

getMaxListeners(): number

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

Returns​

number

Implementation of​

AsyncEventEmitter.getMaxListeners

listeners()​

listeners(eventName): Function[]

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

Get all listeners for an event

Parameters​

eventName​

keyof E

the event name

Returns​

Function[]

the list of results

Implementation of​

AsyncEventEmitter.listeners

off()​

off<Key>(eventName, listener): this

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

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.off

Implementation of​

AsyncEventEmitter.off

on()​

on<Key>(eventName, listener): this

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

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.once

Implementation of​

AsyncEventEmitter.on

once()​

once<Key>(eventName, listener): this

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

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.once

Implementation of​

AsyncEventEmitter.once

removeAllListeners()​

removeAllListeners<Key>(eventName?): this

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

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName?​

Key

the event name

Returns​

this

this for chaining

See​

EventEmitter.removeAllListeners

Implementation of​

AsyncEventEmitter.removeAllListeners

removeListener()​

removeListener<Key>(eventName, listener): this

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

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.removeListener

Implementation of​

AsyncEventEmitter.removeListener

setMaxListeners()​

setMaxListeners(n): this

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

Parameters​

n​

number

Returns​

this

Implementation of​

AsyncEventEmitter.setMaxListeners