@cloudcome/utils-core/dist/emitter.mjs.map

cloudcome core utils

{"version":3,"file":"emitter.mjs","sources":["../src/emitter.ts"],"sourcesContent":["import type { AnyFunction, AnyObject } from './types';\n\n/**\n * 事件类型映射，key 为事件名称，value 为事件参数类型数组\n */\nexport type EmitterMap = Record<string, unknown[]>;\n\n/**\n * 事件监听器函数类型\n * @template E - EmitterMap 类型\n * @template K - 事件名称类型\n */\nexport type EmitterListener<E extends EmitterMap, K extends keyof E> = (...payloads: E[K]) => false | unknown;\n\n/**\n * 事件发射器类，用于管理事件监听和触发\n * @template E - 事件类型映射\n *\n * @example\n * type MyEvents = {\n *   'click': [x: number, y: number];\n *   'change': [value: string];\n * };\n *\n * const emitter = new Emitter<MyEvents>();\n * emitter.on('click', (x, y) => {\n *   console.log(`Clicked at (${x}, ${y})`);\n * });\n * emitter.emit('click', 10, 20);\n */\nexport class Emitter<E extends EmitterMap> {\n  #events: Map<keyof E, Set<AnyFunction>> = new Map();\n\n  /**\n   * 注册事件监听器\n   * @param event - 要监听的事件名称\n   * @param listener - 事件监听器函数\n   * @example\n   * emitter.on('click', (x, y) => {\n   *   console.log(`Clicked at (${x}, ${y})`);\n   * });\n   */\n  on<K extends keyof E>(event: K, listener: EmitterListener<E, K>) {\n    const listeners = this.#events.get(event);\n    if (listeners) {\n      listeners.add(listener);\n    } else {\n      this.#events.set(event, new Set([listener]));\n    }\n  }\n\n  /**\n   * 移除事件监听器，有三种使用方式：\n   * 1. 移除特定事件的特定监听器\n   * 2. 移除特定事件的所有监听器\n   * 3. 移除所有事件的所有监听器\n   * @param event - 要移除的事件名称（可选）\n   * @param listener - 要移除的监听器函数（可选）\n   * @example\n   * // 移除特定事件的特定监听器\n   * emitter.off('click', clickHandler);\n   *\n   * // 移除特定事件的所有监听器\n   * emitter.off('click');\n   *\n   * // 移除所有事件的所有监听器\n   * emitter.off();\n   */\n  off<K extends keyof E>(event?: K, listener?: EmitterListener<E, K>) {\n    if (event && listener) {\n      this.#offListener(event, listener);\n    } else if (event) {\n      this.#offEvent(event);\n    } else {\n      this.#offAll();\n    }\n  }\n\n  #offAll() {\n    this.#events.clear();\n  }\n\n  #offEvent<K extends keyof E>(event: K) {\n    this.#events.delete(event);\n  }\n\n  #offListener<K extends keyof E>(event: K, listener: EmitterListener<E, K>) {\n    const listeners = this.#events.get(event);\n\n    if (listeners) {\n      listeners.delete(listener);\n    }\n  }\n\n  /**\n   * 触发指定事件，调用所有注册的监听器\n   * @param event - 要触发的事件名称\n   * @param payloads - 传递给监听器的参数\n   * @remarks\n   * 监听器会按照注册的顺序依次执行，如果某个监听器返回 false，\n   * 则后续监听器将不会被执行\n   * @example\n   * emitter.emit('click', 10, 20);\n   */\n  emit<K extends keyof E>(event: K, ...payloads: Parameters<EmitterListener<E, K>>) {\n    const listeners = this.#events.get(event) as Set<EmitterListener<E, K>> | undefined;\n\n    if (!listeners) return;\n\n    // 避免在 emit、on 的过程中改变 listeners 从而影响本次 emit\n    for (const listener of [...listeners]) {\n      if (listener(...payloads) === false) {\n        break;\n      }\n    }\n  }\n}\n"],"names":[],"mappings":"AA8BO,MAAM,QAA8B;AAAA,EACzC,8BAA8C,IAAI;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWlD,GAAsB,OAAU,UAAiC;AAC/D,UAAM,YAAY,KAAK,QAAQ,IAAI,KAAK;AACxC,QAAI,WAAW;AACb,gBAAU,IAAI,QAAQ;AAAA,IAAA,OACjB;AACA,WAAA,QAAQ,IAAI,OAAO,oBAAI,IAAI,CAAC,QAAQ,CAAC,CAAC;AAAA,IAAA;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBF,IAAuB,OAAW,UAAkC;AAClE,QAAI,SAAS,UAAU;AAChB,WAAA,aAAa,OAAO,QAAQ;AAAA,eACxB,OAAO;AAChB,WAAK,UAAU,KAAK;AAAA,IAAA,OACf;AACL,WAAK,QAAQ;AAAA,IAAA;AAAA,EACf;AAAA,EAGF,UAAU;AACR,SAAK,QAAQ,MAAM;AAAA,EAAA;AAAA,EAGrB,UAA6B,OAAU;AAChC,SAAA,QAAQ,OAAO,KAAK;AAAA,EAAA;AAAA,EAG3B,aAAgC,OAAU,UAAiC;AACzE,UAAM,YAAY,KAAK,QAAQ,IAAI,KAAK;AAExC,QAAI,WAAW;AACb,gBAAU,OAAO,QAAQ;AAAA,IAAA;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaF,KAAwB,UAAa,UAA6C;AAChF,UAAM,YAAY,KAAK,QAAQ,IAAI,KAAK;AAExC,QAAI,CAAC,UAAW;AAGhB,eAAW,YAAY,CAAC,GAAG,SAAS,GAAG;AACrC,UAAI,SAAS,GAAG,QAAQ,MAAM,OAAO;AACnC;AAAA,MAAA;AAAA,IACF;AAAA,EACF;AAEJ;"}