TS 给对象 (或类) 添加类型定义中不存在的属性

[inkjuncom]

在 TypeScript 中，如果你想给一个对象（或类）添加一个在类型定义中不存在的属性，主要有以下几种方法：

方案 A：类型断言 (Type Assertion) —— 最常用

(InkPromise as any).deferred = () => { ... };

• 优点：简单、直接、代码量少。
• 缺点：完全放弃了类型检查，容易拼写错误。
• 适用场景：临时 hack。

方案 B: 声明合并 (Declaration Merging) —— 最规范

利用 TS 的声明合并特性，补充类型定义。

// 在类定义之外
namespace InkPromise {
  export let deferred: () => any;
}

// 然后再赋值
InkPromise.deferred = () => { ... };

• 优点：类型安全，IDE 有智能提示，符合 TS 设计哲学。
• 缺点：写起来繁琐，对于静态属性的扩展有时比较复杂。
• 适用场景：扩展第三方库的类型，或者在大型项目中需要严格类型定义的场景。

方案 C: 使用 Reflect.set

Reflect.set(InkPromise, 'deferred', () => { ... });

• 优点：语义明确（表示这是一个反射操作），不需要显式的 as any。
• 缺点：在某些严格的 TS 配置下，可能仍需处理类型定义问题；比直接赋值稍微慢一点点（通常可忽略）。
• 适用场景：元编程，或者动态修改对象属性。

方案 D: 索引签名 (Index Signature) —— 最灵活

在定义类或接口时，允许其拥有任意属性

class InkPromise {
  // ... 其他属性
  [key: string]: any; // 允许添加任意字符串键的属性
}
// 使用时
InkPromise.someNewProp = 123; // 合法

• 优点：类型系统原生支持，不需要断言。
• 缺点：会导致该对象的所有属性检查变宽松，失去了 TS 严格检查的保护意义。
• 适用场景：对象本身就是用作字典（Map）或配置项容器时。

总结与推荐

方法	安全性	繁琐度	推荐指数	备注
(obj as any).prop	低	低	⭐⭐⭐⭐⭐	hack 首选，简单直接解决报错
声明合并	高	高	⭐⭐⭐⭐	适合编写库或公共模块
Reflect.set	中	中	⭐⭐⭐	适合元编程或框架底层代码
索引签名	低	低	⭐⭐	除非对象本身就是字典，否则不推荐