EventEmitter <TEventMap>

Excalibur's typed event emitter, this allows events to be sent with any string to Type mapping

Index

Constructors

• constructor

Methods

• clear
• emit
• off
• on
• once
• pause
• pipe
• unpause
• unpipe

Constructors

constructor

• new EventEmitter<TEventMap>(): EventEmitter<TEventMap>

• Type parameters

  • TEventMap: EventMap = any

  Returns EventEmitter<TEventMap>

Methods

clear

• clear(): void

• Removes all listeners and pipes

  ---

  Returns void

emit

• emit<TEventName>(eventName: TEventName, event: TEventMap[TEventName]): void
• emit(eventName: string, event?: any): void

• Type parameters

  • TEventName: string

  Parameters

  • eventName: TEventName

  • event: TEventMap[TEventName]

  Returns void

off

• off<TEventName>(eventName: TEventName, handler: Handler<TEventMap[TEventName]>): void
• off(eventName: string, handler: Handler<unknown>): void
• off(eventName: string): void

• Type parameters

  • TEventName: string

  Parameters

  • eventName: TEventName

  • handler: Handler<TEventMap[TEventName]>

  Returns void

on

• on<TEventName>(eventName: TEventName, handler: Handler<TEventMap[TEventName]>): Subscription
• on(eventName: string, handler: Handler<unknown>): Subscription

• Type parameters

  • TEventName: string

  Parameters

  • eventName: TEventName

  • handler: Handler<TEventMap[TEventName]>

  Returns Subscription

once

• once<TEventName>(eventName: TEventName, handler: Handler<TEventMap[TEventName]>): Subscription
• once(eventName: string, handler: Handler<unknown>): Subscription

• Type parameters

  • TEventName: string

  Parameters

  • eventName: TEventName

  • handler: Handler<TEventMap[TEventName]>

  Returns Subscription

pause

• pause(): void

• Paused event emitters do not emit events

  ---

  Returns void

pipe

• pipe(emitter: EventEmitter<any>): Subscription

• Replay events from this emitter to another

  ---

  Parameters

  • emitter: EventEmitter<any>

  Returns Subscription

unpause

• unpause(): void

• Unpaused event emitter do emit events

  ---

  Returns void

unpipe

• unpipe(emitter: EventEmitter<any>): void

• Remove any piped emitters

  ---

  Parameters

  • emitter: EventEmitter<any>

  Returns void