Class EventEmitter<M, EventMap>

Type Parameters

M extends LooseObject & { cleanup?: never }
EventMap extends { cleanup: null } = M & { cleanup: null }

Hierarchy (View Summary)

EventEmitter

Implements

Disposable

Index

Constructors

Properties

Methods

[dispose] on off once emit

Constructors

constructor

new EventEmitter<
M extends LooseObject & { cleanup?: undefined },
EventMap extends { cleanup: null } = never,
>(): EventEmitter<M, EventMap>
Type Parameters
- M extends LooseObject & { cleanup?: undefined }
- EventMap extends { cleanup: null } = never
Returns EventEmitter<M, EventMap>

Properties

`Protected`listeners

listeners: { [K in string | number | symbol]?: Set<(e: ...) => ...> } = {}

Methods

[dispose]

"[dispose]"(): void
Returns void
Implementation of Disposable.[dispose]
- Defined in packages/psytask/src/util.ts:126

on

on<K extends string | number | symbol>(
type: K,
listener: (evt: EventMap[K]) => void,
): EventEmitter<M, EventMap>
Add event listener
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- listener: (evt: EventMap[K]) => void
Returns EventEmitter<M, EventMap>
- Defined in packages/psytask/src/util.ts:130

off

off<K extends string | number | symbol>(
type: K,
listener: (evt: EventMap[K]) => void,
): EventEmitter<M, EventMap>
Remove event listener
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- listener: (evt: EventMap[K]) => void
Returns EventEmitter<M, EventMap>
- Defined in packages/psytask/src/util.ts:135

once

once<K extends string | number | symbol>(
type: K,
listener: (evt: EventMap[K]) => void,
): EventEmitter<M, EventMap>
Add one-time event listener, can not be removed manually
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- listener: (evt: EventMap[K]) => void
Returns EventEmitter<M, EventMap>
- Defined in packages/psytask/src/util.ts:140

emit

emit<K extends string | number | symbol>(type: K, e: EventMap[K]): number
Emit event listeners
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- e: EventMap[K]
Returns number
- Defined in packages/psytask/src/util.ts:155