You need to enable JavaScript to run this app. TypeScript仿jQuery封装时addEventListener报错及DOM类型应用咨询
优惠活动
大模型
产品
解决方案
定价
更多

TypeScript仿jQuery封装时addEventListener报错及DOM类型应用咨询

无需背记DOM类型的TS使用技巧
  • TS自带的lib.dom.d.ts已经内置了全量的DOM API、元素、事件类型定义,不需要刻意背记所有内容,写代码时IDE会自动根据上下文弹出可用的事件名、API参数提示,输入过程中就能直接看到合法取值。
  • 遇到类型不匹配报错时,直接读TS的错误提示即可,错误本身会明确指出参数需要的类型、和当前传入值的差异,比自行背记类型效率高很多。
  • 自定义封装DOM相关逻辑时,直接复用TS内置的HTMLElement、MouseEvent、HTMLElementEventMap等现成类型即可,不需要从零定义。
  • 高频用到的类型只有少数几个,其余边缘类型用到时悬浮查看定义即可,不需要占用记忆空间。
代码报错修复方案

报错根源拆解

  1. 原on方法的event参数定义为通用string,无法匹配addEventListener第一个重载要求的预定义事件字面量联合类型,只能走第二个支持任意字符串的重载。
  2. 第二个重载要求回调参数为EventListenerOrEventListenerObject,该类型是(evt: Event) => void类型的函数、或实现了handleEvent方法的对象的联合类型,原代码定义的Function | EventListenerObject中,通用Function不约束函数签名,无法匹配内置的EventListener类型定义。
  3. 额外隐藏问题:querySelector的返回值类型是Element | null,原代码直接赋值给非空的HTMLElement属性,也会触发空值类型报错。

修复实现

兼顾类型提示的最优方案

复用TS内置的HTMLElementEventMap做重载定义,支持内置事件自动提示事件名、自动推断回调参数类型:

class $ {
  private element: HTMLElement;
  // 增加非空断言处理querySelector的空值返回,同时限制返回元素类型为HTMLElement
  constructor(selector: string, parent: Document | HTMLElement = document) {
    this.element = parent.querySelector<HTMLElement>(selector)!;
  }
  color(cssColor: string) {
    this.element.style.color = cssColor;
    return this;
  }
  // 重载1:匹配HTMLElement所有内置事件,提供类型提示
  on<K extends keyof HTMLElementEventMap>(
    event: K,
    callback: (evt: HTMLElementEventMap[K]) => void
  ): this;
  // 重载2:支持任意自定义事件
  on(event: string, callback: EventListenerOrEventListenerObject): this;
  // 统一实现逻辑
  on(event: string, callback: EventListenerOrEventListenerObject) {
    this.element.addEventListener(event, callback);
    return this;
  }
}

// 调用时自动提示click等事件名,回调的evt自动推断为MouseEvent类型
const btn = new $("button").color("red").on("click", (evt) => console.log("hi"));

快速简化修复

如果不需要内置事件的类型提示,仅需修正回调类型即可消除报错:

class $ {
  private element: HTMLElement;
  constructor(selector: string, parent: Document | HTMLElement = document) {
    this.element = parent.querySelector<HTMLElement>(selector)!;
  }
  color(cssColor: string) {
    this.element.style.color = cssColor;
    return this;
  }
  on(event: string, callback: EventListenerOrEventListenerObject) {
    this.element.addEventListener(event, callback);
    return this;
  }
}

const btn = new $("button").color("red").on("click", () => console.log("hi"));

内容的提问来源于stack exchange,提问作者Ekmek

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.11.08 03:36:10