阅读 3535

TypeScript声明全局类型

背景

定义TS类型声明文件xxx.d.ts ,文件中的类型,在外部文件使用时,理论上不需要引入文件,直接使用就行。

而自定义的api.d.ts中的类型无法在外部使用。

第一次api.d.ts定义方式

// api.d.ts文件
export interface ListItem {
  date: string;
  ... // 其他属性
}
​
export interface TextItem{
  ...
}
复制代码

以上方式导致外部文件无法感知ListItem、TextItem

解决方式

修正api.d.ts文件,引入namespace关键字

// 修正后的api.d.ts文件
declare namespace API {
  interface ListItem {
    date: string;
    ...
  } 
  // 其他接口
  ...
}
复制代码

总结

TS推荐的声明文件命名方式有三种:

  • module.d.ts - 不能被调用或者构造,例如静态类型
  • module-class.d.ts - 能使用new关键字构造,例如类的定义
  • module-function.d.ts - 能够作为函数被调用,例如函数定义
  • 当自定义模块依赖全局其他模块时
    • 文件顶部加入reference指令
/// <reference types="someLib" />
// 自定义类型模块
// ...
不要使用/// <reference指令去声明UMD库的依赖!
复制代码

参考资料

声明文件定义