PR pixi-reels

EventEmitter\<TEvents\>

pixi-reels


pixi-reels / index / EventEmitter

Class: EventEmitter<TEvents>

Defined in: events/EventEmitter.ts:23

Lightweight 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

Type Parameter
TEvents extends Record<string, unknown[]>

Constructors

Constructor

new EventEmitter<TEvents>(): EventEmitter<TEvents>;

Returns

EventEmitter<TEvents>

Methods

emit()

emit<K>(event: K, ...args: TEvents[K]): boolean;

Defined in: events/EventEmitter.ts:66

Type Parameters

Type Parameter
K extends string | number | symbol

Parameters

ParameterType
eventK
argsTEvents[K]

Returns

boolean


listenerCount()

listenerCount(event: keyof TEvents): number;

Defined in: events/EventEmitter.ts:102

Parameters

ParameterType
eventkeyof TEvents

Returns

number


off()

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

Defined in: events/EventEmitter.ts:42

Type Parameters

Type Parameter
K extends string | number | symbol

Parameters

ParameterType
eventK
fn?(…args: TEvents[K]) => void
context?unknown

Returns

this


on()

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

Defined in: events/EventEmitter.ts:26

Type Parameters

Type Parameter
K extends string | number | symbol

Parameters

ParameterType
eventK
fn(…args: TEvents[K]) => void
context?unknown

Returns

this


once()

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

Defined in: events/EventEmitter.ts:34

Type Parameters

Type Parameter
K extends string | number | symbol

Parameters

ParameterType
eventK
fn(…args: TEvents[K]) => void
context?unknown

Returns

this


removeAllListeners()

removeAllListeners(event?: keyof TEvents): this;

Defined in: events/EventEmitter.ts:93

Parameters

ParameterType
event?keyof TEvents

Returns

this