TypeScript类型兼容问题：子类payload属性无法匹配基类类型

错误原因 #

TypeScript报错的核心是：OrganisationUpdatedPayload没有定义索引签名，而EventInput接口中的payload被定义为Record<string, unknown>（本质是带有任意字符串索引的对象类型），因此TS判定两者类型不兼容。

最优解决方案：泛型改造EventInput接口 #

由于你需要创建多个带有不同payload的事件类，使用泛型可以让EventInput灵活适配任意payload类型，同时保留完整的类型校验：

1. 改造EventInput为泛型接口 #

如果EventInput是你自己维护的代码，直接修改为泛型：

export interface EventInput<T = Record<string, unknown>> {
    eventName: string;
    metadata?: Record<string, string>;
    payload?: T; // 用泛型T替代固定的Record类型
}

如果EventInput来自第三方库（比如@learnapp-co/la-event-utils）无法直接修改，可在本地创建扩展的泛型接口：

import { EventInput as BaseEventInput } from "@learnapp-co/la-event-utils";

// 扩展基础接口，添加泛型支持
export interface EventInput<T = Record<string, unknown>> extends BaseEventInput {
    payload?: T;
}

2. 让事件类实现泛型EventInput #

以OrganisationUpdatedEventInput为例，指定泛型参数为自定义的payload类型：

import { EventUtilsService } from "@learnapp-co/la-event-utils";
import { UpdateOrganisationInterface } from "./interface";
// 引入改造后的泛型接口
import { EventInput } from "./your-local-event-input";

export interface OrganisationUpdatedPayload {
  orgId: string;
  pii: string;
}

// 指定泛型参数为OrganisationUpdatedPayload
export class OrganisationUpdatedEventInput implements EventInput<OrganisationUpdatedPayload> {
  private readonly _eventName = 'OrganisationUpdated';
  private readonly _payload: OrganisationUpdatedPayload;

  constructor(orgId: string, body: UpdateOrganisationInterface, secret: string) {
    this._payload = {
      orgId,
      pii: EventUtilsService.encryptPIIData({
        organisationName: body.name,
        bank: body.bank,
        ...(body.revenuePercentage && { revenuePercentage: body.revenuePercentage }),
      }, secret),
    };
  }

  // 注意：getter名称要和接口的属性名完全一致，接口要求eventName，所以getter是eventName
  public get eventName(): string {
    return this._eventName;
  }

  // 同理，getter名称为payload，匹配接口定义
  public get payload(): OrganisationUpdatedPayload {
    return this._payload;
  }
}

这里要修正原代码的一个问题：原类中的getter命名是getEventName和getPayload，但EventInput接口要求的是eventName和payload属性，必须让getter名称与接口属性名一致，否则TS会判定未实现接口的必填属性。

备选方案：给自定义Payload添加索引签名 #

如果无法修改EventInput接口，可给OrganisationUpdatedPayload添加索引签名，使其符合Record<string, unknown>的类型要求：

export interface OrganisationUpdatedPayload {
  orgId: string;
  pii: string;
  // 添加索引签名，允许任意字符串键，值类型为unknown
  [key: string]: unknown;
}

但这种方案不推荐，因为会丢失类型严格性——你可以给payload添加任意未定义的属性，TS不会报错。如果每个事件类都要添加索引签名，会导致代码冗余且降低类型安全性。

统一规范 #

所有类似OrganisationCreatedEventInput的事件类，都可以遵循相同的泛型实现方式，比如：

// 示例：OrganisationCreatedEventInput
export interface OrganisationCreatedPayload {
  orgId: string;
  creatorId: string;
}

export class OrganisationCreatedEventInput implements EventInput<OrganisationCreatedPayload> {
  // ... 类实现逻辑
}

内容的提问来源于stack exchange，提问作者Hitesh Balwani