0
点赞
收藏
分享

微信扫一扫

TypeScript 类型声明文件

流沙雨帘 2022-11-07 阅读 100

5.TypeScript 类型声明文件

概述

​ 1.TS 的两种文件类型

​ 2.类型声明文件的使用说明

5.1 TS 中的两种文件类型

TS 中有两种文件类型:1 .ts 文件 2 .d.ts 文件。

  • .ts 文件:
  1. 既包含类型信息又可执行代码。

  2. 可以被编译为 .js 文件,然后,执行代码。

  3. 用途:编写程序代码的地方。

  • .d.ts 文件:
  1. 只包含类型信息的类型声明文件。

  2. 不会生成 .js 文件,仅用于提供类型信息。

  3. 用途:为 JS 提供类型信息。

总结:.ts 是 implementation(代码实现文件);.d.ts 是 declaration(类型声明文件)。如果要为 JS 库提供类型信息,要使用 .d.ts 文件。

5.2 类型声明文件的使用说明

在使用 TS 开发项目时,类型声明文件的使用包括以下两种方式:

  1. 使用已有的类型声明文件

  2. 创建自己的类型声明文件

学习顺序:先会用(别人的)再会写(自己的)。

  • 使用已有的类型声明文件:1 内置类型声明文件 2 第三方库的类型声明文件。
  1. 内置类型声明文件:TS 为 JS 运行时可用的所有标准化内置 API 都提供了声明文件。比如,在使用数组时,数组所有方法都会有相应的代码提示以及类型信息:

在这里插入图片描述

实际上这都是 TS 提供的内置类型声明文件。

可以通过 Ctrl + 鼠标左键(Mac:option + 鼠标左键)来查看内置类型声明文件内容。比如,查看 forEach 方法的类型声明,在 VSCode 中会自动跳转到 lib.es5**.d.ts** 类型声明文件中。当然,像 window、document 等 BOM、DOM API 也都有相应的类型声明(lib.dom**.d.ts**)

  1. 第三方库的类型声明文件:目前,几乎所有常用的第三方库都有相应的类型声明文件。

第三方库的类型声明文件有两种存在形式:1 库自带类型声明文件 2 由 DefinitelyTyped 提供。

  1. 库自带类型声明文件:比如,axios。

在这里插入图片描述

  1. 由 DefinitelyTyped 提供。

DefinitelyTyped 是一个 github 仓库,用来提供高质量 TypeScript 类型声明。可以通过 npm/yarn 来下载该仓库提供的 TS 类型声明包,这些包的名称格式为:@types/*。比如,@types/react、@types/lodash 等。

说明:在实际项目开发时,如果你使用的第三方库没有自带的声明文件,VSCode 会给出明确的提示。

在这里插入图片描述

  • 创建自己的类型声明文件:1 项目内共享类型 2 为已有 JS 文件提供类型声明。
  1. 项目内共享类型:如果多个 .ts 文件中都用到同一个类型,此时可以创建 .d.ts 文件提供该类型,实现类型共享。

操作步骤:

  1. 创建 index.d.ts 类型声明文件。

  2. 创建需要共享的类型,并使用 export 导出(TS 中的类型也可以使用 import/export 实现模块化功能)。

  3. 在需要使用共享类型的 .ts 文件中,通过 import 导入即可(.d.ts 后缀导入时,直接省略)。

  • 创建自己的类型声明文件:1 项目内共享类型 2 为已有 JS 文件提供类型声明。
  1. 为已有 JS 文件提供类型声明:

  2. 在将 JS 项目迁移到 TS 项目时,为了让已有的 .js 文件有类型声明。

  3. 成为库作者,创建库给其他人使用。

注意:

说明:TS 项目中也可以使用 .js 文件。

说明:在导入 .js 文件时,TS 会自动加载与 .js 同名的 .d.ts 文件,以提供类型声明。

declare 关键字:用于类型声明,为其他地方(比如,.js 文件)已存在的变量声明类型,而不是创建一个新的变量。

写在最后

✨个人笔记博客✨

星月前端博客
http://blog.yhxweb.top/

举报

相关推荐

0 条评论