Задача: типизированный EventEmitter
На этой странице
Продолжение задачи про EventEmitter: сделать его типобезопасным, чтобы emit("message", 42) давал ошибку компиляции, если событие message ожидает строку, а в on обработчик автоматически получал правильные типы аргументов. Решение — дженерик-класс с картой событий Events extends Record<string, unknown[]>, где ключ — имя события, а значение — кортеж аргументов; методы принимают K extends keyof Events и (...args: Events[K]) => void.
Вопрос
Типизируйте EventEmitter так, чтобы имена событий проверялись, аргументы emit соответствовали событию, а обработчики в on получали правильные типы.
Решение
type EventMap = Record<string, unknown[]>;
type Handler<Args extends unknown[]> = (...args: Args) => void;
class TypedEmitter<Events extends EventMap> {
#handlers: { [K in keyof Events]?: Set<Handler<Events[K]>> } = {};
on<K extends keyof Events>(event: K, handler: Handler<Events[K]>): () => void {
(this.#handlers[event] ??= new Set()).add(handler);
return () => this.off(event, handler);
}
off<K extends keyof Events>(event: K, handler: Handler<Events[K]>): void {
this.#handlers[event]?.delete(handler);
}
once<K extends keyof Events>(event: K, handler: Handler<Events[K]>): () => void {
const wrapper: Handler<Events[K]> = (...args) => {
this.off(event, wrapper);
handler(...args);
};
return this.on(event, wrapper);
}
emit<K extends keyof Events>(event: K, ...args: Events[K]): void {
for (const handler of [...(this.#handlers[event] ?? [])]) handler(...args);
}
}Использование
type ChatEvents = {
message: [text: string, from: { id: string; name: string }];
typing: [userId: string];
disconnected: [];
};
const chat = new TypedEmitter<ChatEvents>();
chat.on("message", (text, from) => {
console.log(`${from.name}: ${text.toUpperCase()}`); // text: string, from: { id; name }
});
chat.emit("message", "Привет", { id: "1", name: "Анна" }); // ok
chat.emit("typing", "1"); // ok
chat.emit("disconnected"); // ok
// chat.emit("message", 42); — ошибка: number не string
// chat.emit("typing"); — ошибка: не хватает аргумента
// chat.on("mesage", () => {}); — ошибка: нет такого события (опечатка)Именованные элементы кортежа (text: string) дают подсказки с именами параметров в редакторе.
Вариант с объектом-payload
type Events2 = {
"cart:add": { productId: string; qty: number };
"cart:clear": void;
};
class Emitter2<E extends Record<string, unknown>> {
#h = new Map<keyof E, Set<(payload: any) => void>>();
on<K extends keyof E>(event: K, fn: (payload: E[K]) => void) {
if (!this.#h.has(event)) this.#h.set(event, new Set());
this.#h.get(event)!.add(fn);
}
emit<K extends keyof E>(event: K, ...payload: E[K] extends void ? [] : [E[K]]) {
this.#h.get(event)?.forEach((fn) => fn(payload[0]));
}
}
const bus = new Emitter2<Events2>();
bus.emit("cart:add", { productId: "p1", qty: 2 });
bus.emit("cart:clear"); // без аргумента благодаря условному кортежуДоп. вопросы интервьюера
- Почему кортеж, а не тип одного аргумента? события с разным числом аргументов, включая ноль, и rest-параметр
...args: Events[K]. - Как типизировать DOM-события так же?
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (e: HTMLElementEventMap[K]) => void)— так устроены встроенные типы DOM. - Есть ли готовые решения?
mitt,eventemitter3,nanoeventsс дженериками,EventTargetсCustomEvent.
Что важно помнить
- Дженерик метода
K extends keyof Eventsсвязывает имя события и тип аргументов. ...args: Events[K]превращает кортеж в список параметров.- Типизация ловит опечатки в именах событий — одна из главных пользы.
- Базовая реализация: EventEmitter; теория: generic-классы, keyof.
Мини-шпаргалка
class TypedEmitter<E extends Record<string, unknown[]>>, методы <K extends keyof E>(event: K, handler: (...args: E[K]) => void), emit(event: K, ...args: E[K]). Карта событий — кортежи с именами. Для payload-объекта — E[K] extends void ? [] : [E[K]].
Документация
TypeScript: Generics, TypeScript: Variadic Tuple Types, mitt.