给开源项目贡献TS类型声明

给开源项目贡献TS类型声明

· 1 分钟阅读时长

项目中使用过redux

声明文件的作用

  1. 编辑器代码不全,接口提示等feat
  2. 类型安全检测

声明文件的创建/使用方式

  1. 编写TS类型程序文件,TSC编译tsc --declaration,生成JS文件的同时即生成.d.ts的声明文件
  2. 手动编写.d.ts类型文件,一般是面向不活跃的项目,无法在本身包中提供类型声明文件,于是发布到@types,生成@types/packageName
  3. 项目中编写.d.ts,同时tsconfig中指向该type文件

几个问题

  1. 类型声明需要引用另一个库的类型声明

    • 直接import即可
  2. 生成器函数的类型声明

    • 使用Generator作为返回类型,不可以使用function*
  3. 针对导出变量的类型声明

代码

写在最后

参考文档

Alan He
Authors
开发者,数码产品爱好者,喜欢折腾,喜欢分享,喜欢开源