Class EventEmitter<TEventMap>
Methods
clear
- clear(): void
Returns void
emit
- emit<TEventName>(eventName, event): void
Type Parameters
TEventName extends string
Parameters
eventName: TEventName
event: TEventMap[TEventName]
Returns void
- emit(eventName, event?): void
Parameters
eventName: string
Optional
event: any
Returns void
off
- off<TEventName>(eventName, handler): void
Type Parameters
TEventName extends string
Parameters
eventName: TEventName
handler: Handler<TEventMap[TEventName]>
Returns void
- off(eventName, handler): void
Parameters
eventName: string
handler: Handler<unknown>
Returns void
- off(eventName): void
Returns void
on
- on<TEventName>(eventName, handler): Subscription
Type Parameters
TEventName extends string
Parameters
eventName: TEventName
handler: Handler<TEventMap[TEventName]>
- on(eventName, handler): Subscription
Parameters
eventName: string
handler: Handler<unknown>
once
- once<TEventName>(eventName, handler): Subscription
Type Parameters
TEventName extends string
Parameters
eventName: TEventName
handler: Handler<TEventMap[TEventName]>
- once(eventName, handler): Subscription
Parameters
eventName: string
handler: Handler<unknown>
pause
- pause(): void
Returns void
unpause
- unpause(): void
Returns void
unpipe
- unpipe(emitter): void
Returns void
Excalibur's typed event emitter, this allows events to be sent with any string to Type mapping