EventEmitter\<TEvents *extends* `Record`\<`string`, `unknown`[]\>\>

pixi-reels

pixi-reels / index / EventEmitter

Class: EventEmitter<TEvents extends Record<string, unknown[]>>

Defined in: events/EventEmitter.ts:23

Typed event emitter with zero dependencies.

Usage:

interface MyEvents {
  'foo': [x: number, y: string];
  'bar': [];
}
const emitter = new EventEmitter<MyEvents>();
emitter.on('foo', (x, y) => console.log(x, y));
emitter.emit('foo', 42, 'hello');

Type Parameters#

Constructors#

Constructor#

new EventEmitter<TEvents extends Record<string, unknown[]>>(): EventEmitter<TEvents>;

Returns#

EventEmitter<TEvents>

Methods#

emit()#

emit<K extends string | number | symbol>(event: K, ...args: TEvents[K]): boolean;

Defined in: events/EventEmitter.ts:82

Type Parameters#

Parameters#

Returns#

boolean

listenerCount()#

listenerCount(event: keyof TEvents): number;

Defined in: events/EventEmitter.ts:127

Parameters#

Returns#

number

off()#

off<K extends string | number | symbol>(
   event: K, 
   fn?: (...args: TEvents[K]) => void, 
   context?: unknown
): this;

Defined in: events/EventEmitter.ts:43

Type Parameters#

Parameters#

Returns#

this

offAny()#

offAny(fn: (event: Extract<keyof TEvents, string>, ...args: unknown[]) => void): this;

Defined in: events/EventEmitter.ts:77

Parameters#

Returns#

this

on()#

on<K extends string | number | symbol>(
   event: K, 
   fn: (...args: TEvents[K]) => void, 
   context?: unknown
): this;

Defined in: events/EventEmitter.ts:27

Type Parameters#

Parameters#

Returns#

this

onAny()#

onAny(fn: (event: Extract<keyof TEvents, string>, ...args: unknown[]) => void): this;

Defined in: events/EventEmitter.ts:72

Hear every event this emitter raises, name first: for a trace, an events panel, a recorder. Not for game logic, which names the events it wants. Runs after the event’s own listeners.

Parameters#

Returns#

this

once()#

once<K extends string | number | symbol>(
   event: K, 
   fn: (...args: TEvents[K]) => void, 
   context?: unknown
): this;

Defined in: events/EventEmitter.ts:35

Type Parameters#

Parameters#

Returns#

this

removeAllListeners()#

removeAllListeners(event?: keyof TEvents): this;

Defined in: events/EventEmitter.ts:117

Parameters#

Returns#

this