Skip to content

Documentation / listr2 / EventManager

Class: EventManager<Event, Map> ​

Defined in: packages/listr2/src/lib/event-manager.ts:5

Extended by ​

Type Parameters ​

Event ​

Event extends string = string

Map ​

Map extends Partial<Record<Event, unknown>> = Partial<Record<Event, any>>

Constructors ​

Constructor ​

new EventManager<Event, Map>(): EventManager<Event, Map>

Defined in: packages/listr2/src/lib/event-manager.ts:8

Returns ​

EventManager<Event, Map>

Methods ​

emit() ​

emit<E>(dispatch, args?): void

Defined in: packages/listr2/src/lib/event-manager.ts:12

Type Parameters ​

E ​

E extends string = Event

Parameters ​

dispatch ​

E

args? ​

EventData<E, Map>

Returns ​

void


on() ​

on<E>(dispatch, handler): void

Defined in: packages/listr2/src/lib/event-manager.ts:16

Type Parameters ​

E ​

E extends string = Event

Parameters ​

dispatch ​

E

handler ​

(data) => void

Returns ​

void


once() ​

once<E>(dispatch, handler): void

Defined in: packages/listr2/src/lib/event-manager.ts:24

Type Parameters ​

E ​

E extends string = Event

Parameters ​

dispatch ​

E

handler ​

(data) => void

Returns ​

void


off() ​

off<E>(dispatch, handler?): void

Defined in: packages/listr2/src/lib/event-manager.ts:32

Type Parameters ​

E ​

E extends string = Event

Parameters ​

dispatch ​

E

handler? ​

(data) => void

Returns ​

void


complete() ​

complete(): void

Defined in: packages/listr2/src/lib/event-manager.ts:40

Returns ​

void