TypeScript开发discord bot时如何定义参数不固定的Event类run方法

核心思路是通过TypeScript泛型+抽象类+Discord.js内置事件类型映射实现需求，既可以强制子类必须实现run方法，又能让不同事件子类的run方法自动匹配对应参数类型。

步骤1：重定义事件接口与抽象基类 #

首先利用Discord.js内置的ClientEvents类型（已经包含所有官方事件的参数映射），改造接口和基类：

// file: src\interface\EventInt.ts
import type { ClientEvents } from "discord.js";
import CustomClient from "../libs/customClient";

// 泛型K为事件名称，继承ClientEvents的键名
export default interface EventInt<K extends keyof ClientEvents = keyof ClientEvents> {
  client: CustomClient;
  name: K;
  run: (...args: ClientEvents[K]) => Promise<void> | void;
}

// file: src\libs\structure\event\Event.ts
import type { ClientEvents } from "discord.js";
import CustomClient from "../../customClient";
import type EventInt from "../../../interface/EventInt";

// 定义抽象基类，实现EventInt接口
export default abstract class Event<K extends keyof ClientEvents> implements EventInt<K> {
  client: CustomClient;
  name: K;

  constructor(client: CustomClient, name: K) {
    this.client = client;
    this.name = name;
  }

  // 定义抽象run方法，强制子类必须实现，参数自动匹配对应事件的参数类型
  abstract run: (...args: ClientEvents[K]) => Promise<void> | void;
}

如果有自定义事件，不需要用Discord内置的ClientEvents，可以自己定义事件参数映射类型替换即可。

步骤2：子类实现示例 #

继承基类时传入对应事件名称作为泛型参数，run方法的参数类型会自动推导，不需要手动定义也能获得类型校验：

错误事件示例 #

// file: src\events\ErrorEvent.ts
import CustomClient from "../libs/customClient";
import Event from "../libs/structure/event/Event";

// 传入error作为泛型参数
export default class ErrorEvent extends Event<"error"> {
  constructor(client: CustomClient) {
    super(client, "error");
  }

  // 参数error自动推导为Error类型，和discord.js error事件的原生参数完全匹配
  run = async (error: Error): Promise<void> => {
    console.log("Discord client error!", error);
  };
}

消息事件示例 #

// file: src\events\MessageEvent.ts
import type { Message } from "discord.js";
import CustomClient from "../libs/customClient";
import Event from "../libs/structure/event/Event";

export default class MessageEvent extends Event<"messageCreate"> {
  constructor(client: CustomClient) {
    super(client, "messageCreate");
  }

  // 参数自动推导为Message类型
  run = async (message: Message): Promise<void> => {
    console.log("收到新消息:", message.content);
  };
}

步骤3：主文件注册事件逻辑 #

注册时不需要额外处理类型，直接透传参数即可，TypeScript会自动校验类型匹配：

// 遍历导入事件文件的逻辑省略，拿到事件实例event后注册
client.on(event.name, (...args) => event.run(...args));

方案优势 #

• 强制约束：抽象类的run方法为抽象方法，子类未实现时编译阶段直接报错，符合要求
• 类型安全：不同事件的run参数自动匹配对应类型，不需要手动写大量类型判断，也避免传参错误
• 可扩展性：新增事件只需要继承基类传入对应事件名即可，不需要修改基类和接口代码

内容的提问来源于stack exchange，提问作者Steve P Sajeev