EventHandler
Defined in: classes/event-handler.ts:2
Class representing an asynchronous event handler
Type Parameters
Section titled “Type Parameters”Events
Section titled “Events”Events extends Record<string, any[]>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new EventHandler<
Events>():EventHandler<Events>
Returns
Section titled “Returns”EventHandler<Events>
Methods
Section titled “Methods”emit()
Section titled “emit()”emit<
K>(event, …args):Promise<boolean>
Defined in: classes/event-handler.ts:68
Emit an event by name
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”K
Event name
…Events[K]
Event arguments
Returns
Section titled “Returns”Promise<boolean>
Boolean representing whether at least one listener function was called
off<
K>(event,listener):EventHandler<Events>
Defined in: classes/event-handler.ts:50
Remove an event listener
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”K
Event name
listener
Section titled “listener”(…args) => any
Listener callback
Returns
Section titled “Returns”EventHandler<Events>
EventHandler instance
on<
K>(event,listener):EventHandler<Events>
Defined in: classes/event-handler.ts:13
Add an event listener that can run multiple times
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”K
Event name
listener
Section titled “listener”(…args) => any
Listener callback
Returns
Section titled “Returns”EventHandler<Events>
EventHandler instance
once()
Section titled “once()”once<
K>(event,listener):EventHandler<Events>
Defined in: classes/event-handler.ts:31
Add an event listener that only runs one time
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”K
Event name
listener
Section titled “listener”(…args) => any
Listener callback
Returns
Section titled “Returns”EventHandler<Events>
EventHandler instance