TypeDoc中保留枚举类型名称而非显示原始类型的技巧

在使用TypeDoc为TypeScript项目生成API文档时，开发者经常会遇到一个令人困扰的问题：当返回类型是枚举或常量时，文档中显示的却是原始类型（如number或string），而不是开发者定义的类型名称。这个问题会影响API文档的可读性和实用性。

问题现象

考虑以下TypeScript代码示例：

export const CameraCasualFilters = {
  NoFilter: 0,
  FilterFoo: 1,
  FilterBar: 2,
} as const;

export type CameraCasualFilters = typeof CameraCasualFilters[keyof typeof CameraCasualFilters];

get cameraFilter(): CameraCasualFilters {
  return this.filterId;
}

开发者期望在生成的文档中看到返回类型显示为CameraCasualFilters，但实际上TypeDoc却显示为number。这种表现使得文档失去了类型命名的语义信息，降低了文档的实用价值。

问题根源

这一现象的根本原因在于TypeDoc完全依赖TypeScript的类型检查器来获取类型信息。当TypeScript将类型解析为原始类型（如number）时，TypeDoc也会相应地显示原始类型而非类型别名。

解决方案

要解决这个问题，我们需要创建一个既与原始类型兼容又能保持独立性的类型别名。具体方法是在类型别名前添加{} &：

export type CameraCasualFilters = {} & (typeof CameraCasualFilters)[keyof typeof CameraCasualFilters];

这个技巧利用了TypeScript的类型别名保留机制：

1. {} &部分创建了一个空对象类型的交叉类型
2. 这个交叉类型在运行时实际上不会产生任何影响
3. 但在类型系统中，它能够触发TypeScript保留类型别名的名称

效果对比

应用此解决方案后，TypeDoc生成的文档将正确显示类型名称为CameraCasualFilters，而不是原始的number类型。这使得API文档更加清晰和具有语义性。

额外建议

1. 不需要使用@hidden标记类型别名，因为@enum标签会自动阻止类型别名被转换
2. 对于枚举类型，考虑使用TypeScript的enum语法，它通常能更好地与文档工具集成
3. 在复杂类型系统中，合理使用类型别名可以显著提高代码和文档的可读性

总结

通过理解TypeDoc与TypeScript类型系统的交互方式，我们可以使用简单的类型技巧来改善生成的文档质量。{} &交叉类型是一个轻量级的解决方案，它既保持了类型的原始行为，又能在文档中保留有意义的类型名称。这种技巧特别适用于需要精确控制文档输出的库开发者。