Class: EventEmitter
Class: EventEmitter
Class representing an EventEmitter.
Constructors
Constructor
new EventEmitter(): EventEmitter;
Create an EventEmitter.
Returns
EventEmitter
Methods
emit()
emit<TEvent>(event, args?): Promise<void>;
Emits an event, triggering all associated listeners.
Type Parameters
TEvent
Parameters
event
The event name or an instance of Event.
string
| symbol
| TEvent
args?
any
Additional arguments to pass to the listeners.
Returns
Promise
<void
>
off()
off<TEvent>(event, handler): this;
Removes an event listener for the given event type.
Type Parameters
TEvent
Parameters
event
The event name or type.
handler
MixedListenerHandler
<TEvent
, WildcardEventName
>
The callback to remove.
Returns
this
on()
on<TEvent>(event, handler): this;
Registers an event listener for the given event type.
Type Parameters
TEvent
Parameters
event
The event name or type.
handler
MixedListenerHandler
<TEvent
, WildcardEventName
>
The callback to invoke when the event is emitted.
Returns
this
create()
static create(): EventEmitter;
Create an EventEmitter.
Returns
EventEmitter
A new EventEmitter instance.