types/async-event-emitter
types/async-event-emitter
Section titled “types/async-event-emitter”Classes
Section titled “Classes”AsyncEventEmitter
Section titled “AsyncEventEmitter”Defined in: src/types/async-event-emitter.ts:10
Simple asynchronous event emitter class.
Note: This class is not thread-safe.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AsyncEventEmitter():
AsyncEventEmitter
Returns
Section titled “Returns”Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
off | (eventName, listener) => AsyncEventEmitter | Alias for removeListener. | src/types/async-event-emitter.ts:82 |
Methods
Section titled “Methods”emitAsync()
Section titled “emitAsync()”emitAsync(
eventName,event):Promise<void>
Defined in: src/types/async-event-emitter.ts:21
Emit an event and wait for all registered listeners to be run one-by-one in the order they were registered.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
eventName | string | symbol | The name of the event |
event | unknown | The event payload |
Returns
Section titled “Returns”Promise<void>
on(
eventName,listener):AsyncEventEmitter
Defined in: src/types/async-event-emitter.ts:33
Register an event listener for the given event.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
eventName | string | symbol | The name of the event |
listener | AsyncEventListener | The listener to trigger |
Returns
Section titled “Returns”The AsyncEventEmitter so you can chain registrations
once()
Section titled “once()”once(
eventName,listener):AsyncEventEmitter
Defined in: src/types/async-event-emitter.ts:45
Register an event listener for the given event that is only fired once.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
eventName | string | symbol | The name of the event |
listener | AsyncEventListener | The listener to trigger |
Returns
Section titled “Returns”The AsyncEventEmitter so you can chain registrations
removeListener()
Section titled “removeListener()”removeListener(
eventName,listener):AsyncEventEmitter
Defined in: src/types/async-event-emitter.ts:63
Removes an event listener from the given event.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
eventName | string | symbol | The name of the event |
listener | AsyncEventListener | The listener to remove |
Returns
Section titled “Returns”The AsyncEventEmitter so you can chain registrations
Type Aliases
Section titled “Type Aliases”AsyncEventListener()
Section titled “AsyncEventListener()”AsyncEventListener = (
event,eventName) =>Promise<void> |void
Defined in: src/types/async-event-emitter.ts:4
An asynchronous event listener
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
event | unknown |
eventName | string | symbol |
Returns
Section titled “Returns”Promise<void> | void