TypeScript中如何正确为enum类型及其对象设置别名

迁移背景 #

我们正在将部分代码从Closure类型系统迁移至TypeScript。此前代码中的@enum与@typedef均作为类的静态成员导出，旧Closure风格代码示例：

export class C {}

/** @enum {number} */
C.E = {v0: 0, v1: 1, v2: 2};

/** @typedef { ... 省略内容 ... } */
C.T;

TypeScript原生不支持将类型声明为类的静态成员：无论是在类声明内使用static关键字，还是enum C.E {…这类语法均无法通过编译。初期保持向后兼容的方案是使用TS声明合并特性，示例如下：

export class C {}

export namespace C {
  export enum E {v0, v1, v2};
  export type T = /* 省略具体类型定义 */;
}

该方案可正常运行，符合预期。

过渡阶段双导出实现 #

我们需要将模块导出方式从「作为类静态属性挂载类型」过渡为「独立具名导出」，过渡阶段需要同时支持两种导出形式。其中typedef类型可直接通过类型别名导出，但enum类型存在两类兼容问题：

• 若编写export type E = C.E;：仅导出类型，编译后JS中运行时的E为undefined
• 若编写export const E = C.E;：仅导出运行时对象，将E作为类型使用时会抛出'E' refers to a value, but is being used as a type here错误

正确的双导出写法需要同时导出枚举的值和类型，代码如下：

export class C {}

export namespace C {
  export enum E {v0, v1, v2};
  export type T = /* 省略具体类型定义 */;
}

// 独立具名导出，同时兼容值访问和类型引用
export const E = C.E;
export type E = C.E;
export type T = C.T;

这种写法下，两种访问形式均能正常工作：既可以通过C.E/C.T访问旧挂载形式的枚举和类型，也可以直接从模块顶层导入具名的E/T使用。

移除类静态属性阶段的兼容实现 #

后续计划移除类上的静态属性时，可以将枚举、类型的原始声明移出合并命名空间，再在命名空间内重新导出，保留旧调用方式的兼容性，正确写法如下：

export class C {}

// 顶层独立声明，作为后续唯一的真实来源
export enum E {v0, v1, v2};
export type T = /* 省略具体类型定义 */;

// 与类C合并的命名空间，仅做兼容导出
export namespace C {
  // 通过别名导入规避自引用报错
  import _T = T;
  export type T = _T;

  import _E = E;
  // 同时导出枚举的值和类型
  export const E = _E;
  export type E = _E;
}

注意：不要在合并命名空间内直接使用export { E, T }的形式重新导出，部分TS版本下会因为同名类合并出现识别异常，通过import别名中转的方式可以完全规避自引用和合并冲突问题。

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