Перейти к содержанию

Типизированный эмиттер событий

Обычно в Node.js и традиционном JavaScript у вас есть один эмиттер событий. Этот эмиттер событий внутри отслеживает слушателя для разных типов событий, например:

1
2
3
4
5
6
7
const emitter = new EventEmitter();
// Издать:
emitter.emit('foo', foo);
emitter.emit('bar', bar);
// Слушать:
emitter.on('foo', (foo) => console.log(foo));
emitter.on('bar', (bar) => console.log(bar));

По сути, EventEmitter хранит данные в виде сопоставленных массивов:

1
{foo: [fooListeners], bar: [barListeners]}

Вместо этого, в целях типизации события, вы можете создать эмиттер для определённого типа события:

1
2
3
4
5
6
7
8
9
const onFoo = new TypedEvent<Foo>();
const onBar = new TypedEvent<Bar>();

// Издать:
onFoo.emit(foo);
onBar.emit(bar);
// Слушать:
onFoo.on((foo) => console.log(foo));
onBar.on((bar) => console.log(bar));

Это дает следующие преимущества:

  • Типы событий легко обнаруживаются как переменные.
  • Переменные генератора событий легко рефакторятся независимо.
  • Типизация структур данных событий.

Ссылка TypedEvent

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
export interface Listener<T> {
    (event: T): any;
}

export interface Disposable {
    dispose();
}

/** проходит через события по мере их возникновения. Вы не будете получать
 *  события до того, как начнете слушать */
export class TypedEvent<T> {
    private listeners: Listener<T>[] = [];
    private listenersOncer: Listener<T>[] = [];

    on = (listener: Listener<T>): Disposable => {
        this.listeners.push(listener);
        return {
            dispose: () => this.off(listener),
        };
    };

    once = (listener: Listener<T>): void => {
        this.listenersOncer.push(listener);
    };

    off = (listener: Listener<T>) => {
        var callbackIndex = this.listeners.indexOf(
            listener
        );
        if (callbackIndex > -1)
            this.listeners.splice(callbackIndex, 1);
    };

    emit = (event: T) => {
        /** Обновить слушателей */
        this.listeners.forEach((listener) =>
            listener(event)
        );

        /** Очистить очередь единожды */
        if (this.listenersOncer.length > 0) {
            const toCall = this.listenersOncer;
            this.listenersOncer = [];
            toCall.forEach((listener) => listener(event));
        }
    };

    pipe = (te: TypedEvent<T>): Disposable => {
        return this.on((e) => te.emit(e));
    };
}

Комментарии