Skip to content

输入事件 Emitter

中等 约 20 分钟

你将构建什么

EventEmitter 类那个 uses mapped 类型到 映射事件 names 到 payload 类型. Emitting or listening 到事件使用错误 payload 类型是 编译错误.

学习目标

  • Use mapped 类型到 定义事件映射
  • Enforce 类型-safe 事件 payloads
  • 练习 generic 类设计
  • 构建 publish-subscribe 模式使用完整类型 safety

前置要求

  • Generics
  • Mapped 类型
  • 类

步骤

  1. 1

    定义事件映射接口

    创建接口那个映射事件 names 到它们的 payload 类型. 这个是 源的 truth for 所有事件.

    代码
    interface Events {
      login: { userId: string; timestamp: number };
      logout: { userId: string };
      error: { code: number; message: string };
    }

    预期结果

    事件映射使用 three 事件, 每个使用特定 payload 类型.

  2. 2

    编写输入 EventEmitter 类

    创建 generic 类 parameterized 通过事件映射. on and emit 方法 use keyof and indexed access 类型到 enforce payload 类型.

    代码
    class TypedEmitter<E extends Record<string, any>> {
      private handlers: { [K in keyof E]?: ((payload: E[K]) => void)[] } = {};
      on<K extends keyof E>(event: K, handler: (payload: E[K]) => void) {
        (this.handlers[event] ||= []).push(handler);
      }
      emit<K extends keyof E>(event: K, payload: E[K]) {
        this.handlers[event]?.forEach(h => h(payload));
      }
    }

    预期结果

    fully 输入事件 emitter. 错误 payload 类型是 编译错误.

  3. 3

    Use 输入 emitter

    Instantiate emitter 使用你的事件类型. TypeScript 现在检查每个 on and emit call 针对事件映射.

    代码
    const emitter = new TypedEmitter<Events>();
    emitter.on("login", (p) => console.log(p.userId));
    emitter.emit("login", { userId: "abc", timestamp: Date.now() });
    // emitter.emit("login", { wrong: true }); // Compile error!

    预期结果

    事件 names and payloads 是 fully 类型-检查. Typos or 错误 shapes 是 caught at 编译时间.

  4. 4

    添加类型守卫与运行时检查

    编写类型守卫函数(user-defined type guard)在运行时验证数据形状,结合 unknown 类型安全处理外部输入。类型守卫让 TypeScript 在运行时也有类型安全。

    代码
    type User = { id: number; name: string };
    
    function isUser(value: unknown): value is User {
      if (typeof value !== "object" || value === null) return false;
      const obj = value as Record<string, unknown>;
      return typeof obj.id === "number" && typeof obj.name === "string";
    }
    
    // Usage with unknown input
    const data: unknown = JSON.parse(rawJson);
    if (isUser(data)) {
      console.log(data.name); // TS knows data is User here
    } else {
      console.error("Invalid user data");
    }

    预期结果

    isUser 返回 true 时 TS 将 data 收窄为 User 类型;非法数据走 else 分支。

  5. 5

    添加泛型工具函数

    编写泛型工具函数(如 deepFreeze、groupBy)增强类型安全的复用能力。泛型让工具函数适用于多种类型而不丢失类型信息。

    代码
    function groupBy<T, K extends string | number>(
      items: T[],
      keyFn: (item: T) => K
    ): Record<K, T[]> {
      const result = {} as Record<K, T[]>;
      for (const item of items) {
        const key = keyFn(item);
        (result[key] ??= []).push(item);
      }
      return result;
    }
    
    // Usage
    const byAge = groupBy(users, u => u.age);

    预期结果

    groupBy 对任意类型数组按键分组,返回类型安全的 Record。

自己动手试试

你学到了什么

你构建类型-safe 事件 emitter 哪里事件 names and payloads 是验证 at 编译时间. 这个模式 — using 记录类型 as 类型-level 映射 — 是 widely used in 真实-世界 TypeScript 库 for APIs, 存储, and 事件系统.

查阅不认识的术语

新手友好的术语表用大白话解释编程术语——变量、函数、DOM、Promise 等等。

查看术语表

解读错误信息

用大白话解释常见错误——什么意思、为什么发生、如何修复。

查看错误

← 返回主题