TypeScript如何获取对象键作为函数入参的智能提示

在Nest.js服务中，存在一个服务方法，该方法接收错误码作为入参，返回后续展示给用户的错误提示信息，原始简化实现如下：

getGenericErrorMessage(input: string): string {
  const errorMessages = {
    unknownError: 'An unknown error occurred. ',
    noResponse: 'The Application did not send a response. ',
  };
  return errorMessages[input] || errorMessages['unknownError'];
}

当前实现把入参标注为string类型，调用时IDE无法给出预设错误码的提示，传入拼写错误的错误码时也不会有提前告警，只能在运行时走兜底逻辑。

核心实现思路 #

不需要额外维护独立的错误码枚举或类型，直接通过TypeScript自带的类型操作符，从已定义的错误消息对象上反向提取合法键的联合类型，作为入参的类型标注即可。需要注意的是，如果错误消息对象定义在方法内部，方法签名的入参位置无法访问内部声明的类型，因此推荐把错误消息表抽成模块级或类级的常量，顺便还能避免每次调用方法都重新创建对象，减少不必要的性能开销。

方案1：严格类型校验（推荐） #

这种写法会在编译阶段拦截不合法的错误码入参，智能提示最完整，重构后代码如下：

// 抽为常量，避免重复创建
const ERROR_MESSAGES = {
  unknownError: 'An unknown error occurred. ',
  noResponse: 'The Application did not send a response. ',
} as const;

// 自动提取合法键的联合类型：'unknownError' | 'noResponse'
type ValidErrorCode = keyof typeof ERROR_MESSAGES;

getGenericErrorMessage(input: ValidErrorCode): string {
  return ERROR_MESSAGES[input] || ERROR_MESSAGES['unknownError'];
}

实现效果：

• 调用方法时，IDE会自动弹出所有预设错误码的补全提示
• 传入拼写错误、未定义的错误码时，TS会直接抛出类型错误，提前发现问题
• 后续新增、删除错误码时，只需要修改ERROR_MESSAGES对象即可，类型会自动同步，不需要手动维护

方案2：兼容动态错误码场景 #

如果业务中存在后端动态返回、不在本地预设表内的错误码，需要保留入参兼容任意字符串的能力，可以把入参类型调整为「合法错误码联合类型 | string」，既保留智能提示，又不会限制动态入参：

const ERROR_MESSAGES = {
  unknownError: 'An unknown error occurred. ',
  noResponse: 'The Application did not send a response. ',
} as const;

type ValidErrorCode = keyof typeof ERROR_MESSAGES;

getGenericErrorMessage(input: ValidErrorCode | string): string {
  return ERROR_MESSAGES[input as ValidErrorCode] || ERROR_MESSAGES['unknownError'];
}

这种写法下，输入预设错误码的前缀时IDE会正常弹出补全提示，传入其他任意字符串也不会报类型错误，运行时仍然会走兜底的未知错误提示逻辑，适配动态错误码的业务场景。

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