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

本文介绍关于给开源项目贡献TS类型声明,包括使用场景、实现细节等,以提高关于给开源项目贡献TS类型声明的效率。

9月 12, 2021 · 1 分钟阅读时长 · 310 字 · -阅读 -评论 · 编程开发
TypeScript Read in English 🇺🇸
AI 研读

选择 AI 助手

ChatGPT 携带文章链接与提示词,在新标签页打开
Claude 复制提示词后前往 Claude

打开 Claude
无法读取文章?

若提示词未带入,请复制下方完整提示词到 AI 助手。若 AI 无法读取文章,请粘贴你希望讨论的可见段落,并说明你的问题。

项目中使用过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 H
Authors
开发者,数码产品爱好者,喜欢折腾,喜欢分享,喜欢开源