Class EventDispatcher<T>

Intentionally very simple event emitter.

Type Parameters

T extends Record<keyof T, unknown[]>

Hierarchy (View Summary)

EventDispatcher
- Serializer

Index

Constructors

Methods

Constructors

constructor

new EventDispatcher<T extends Record<keyof T, unknown[]>>(): EventDispatcher<T>
Type Parameters
- T extends Record<keyof T, unknown[]>
Returns EventDispatcher<T>

Methods

off

off<K extends string | number | symbol>(
event: K,
listener: (this: undefined, ...args: T[K]) => void,
): void
Stops listening to an event.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
  the event to stop listening to.
- listener: (this: undefined, ...args: T[K]) => void
  the function to remove from the listener array.
Returns void
- Defined in lib/utils-common/events.ts:42

on

on<K extends string | number | symbol>(
    event: K,
    listener: (this: undefined, ...args: T[K]) => void,
    priority?: number,
): void
Starts listening to an event.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
  the event to listen to.
- listener: (this: undefined, ...args: T[K]) => void
  function to be called when an this event is emitted.
- priority: number = 0
  optional priority to insert this hook with. Higher priority is placed earlier in the listener array.
Returns void
- Defined in lib/utils-common/events.ts:27

trigger

trigger<K extends string | number | symbol>(event: K, ...args: T[K]): void
Emits an event to all currently subscribed listeners.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
  the event to emit.
- ...args: T[K]
  any arguments required for the event.
Returns void
- Defined in lib/utils-common/events.ts:60