前言
我们都知道TS提供了类型,才有了类型保护机制和代码提示等机制。但是在很多使用第三方库中你会发现,他们机会都有TS的类型,这些类型是怎么来的呢?这就要提到类型声明文件了。
目标
- 了解类型声明文件.d.ts与.ts文件的区别
- 如何使用类型声明文件
- 掌握如何创建自己的类型声明文件
1 类型声明文件.d.ts与.ts文件的区别]
TS的文件分为两类:1 .ts文件 2 .d.ts文件
- .ts文件
- 既包含
类型信息
又可执行代码
- 可以被编译为.s 文件,然后,执行代码
- 用途:编写程序代码的地方
- .d.ts文件
- 只包含
类型信息
的类型声明文件 不会生成 .js 文件
,仅用于提供类型信息
- 用途:为JS提供类型信息。
在.d.ts文件中可以声明类型信息,但是写可执行会报错
2 类型声明文件的使用方法
类型声明文件的使用方式有以下两种方式:
- 使用已有的类型声明文件
- 内置类型声明文件
- 第三方库类型声明文件:1 库自带的类型声明文件 2 由 DefinitelyTyped 提供
- 创建自己的类型声明文件
2.1 使用已有的类型锁门文件
2.1.1 内置类型声明文件
内置类型声明文件: TS为JS运行时可用的所有标准化内置API都提供了声明文件
比如,在使用数组时,数组所有方法都会有相应的代码提示以及类型信息:
实际上的TS提供的内置声明文件
2.1.2 第三方库类型声明文件
第三方库的类型声明文件有两种存在形式: 1库自带类型声明文件
2 由 DefinitelyTyped 提供
。
1 库自带类型声明文件
例如axios,导入成功后依赖症中自带了.d.ts类型声明文件
该库的package.json文件中的typings(用types也可以)
指定了类型声明文件的地址。使用时会自动的加载类型声明文件
2 由 DefinitelyTyped 提供
DefinitelyTyped
是一个 github 仓库,用来提供高质量TypeScript 类型声明
可以npm/yarn下载该仓库提供的TS类型声明包,这些包的名称格式为:@types/*。例如:@typs/lodash
无类型声明,VScode会自动的给出提示
npm i -D @typs/lodash
安装成功后 TS会自动的加载该类声明,以供该库的类型声明
2.2 创建自己的类型声明文件
创建自己的类型声明文件: 1 项目内共享类型
2 为已有JS 文件提供类型声明
2.2.1 项目内共享类型
项目内共享类型: 如果多个.ts 文件中都用到同一个类型,此时可以创建.d.ts 文件提供该类型,实现类型共享。
1 创建index.d.ts类型声明文件
2 创建需要共享的类型,并使用export导出
3 .ts文件中,用import引入index.d.ts并使用
2.2.2 为已有JS 文件提供类型声明
- 在将
JS项目
迁移到TS项目
时,为了让已有的.js文件有类型声明 - 成为库作者,创建库给其他人使用。
注意:类型声明文件的编写与模块化方式相关
,不同的模块化方式有不同的写法。但由于历史原因,JS 模块化的发展经历过多种变化(AMD、Common5、UMD、ESModule等),而TS支持各种模块化形式的类型声明。这就导致,类型声明文件相关内容又多又杂。
如何在TS项目中使用.js文件?
在开始之前我们要先了解,两个规则
- 1 在导入.js文件时,.
ts会自动加载与.js同名的.d.ts文件
,以提供说明 - 2
declare
关键字:用于类型声明,为其他地方(比如,.s文件)已存在的变量声明类型
,而不是创建一个新的变量
。
对于type、interface
等这些明确就是TS 类型的(只能在TS 中使用的),可以省略declare 关键字。
对于let、function
等具有双重含义(在JS、TS 中都能用),应该使用 declare 关键字,明确指定此处用于类型声明
1 入口文件引入.ts文件并用ts-loader去处理.ts 或 .tsx文件
2 在index.ts文件中引入.js文件
若还未设置与.js同名的.d.ts文件,那么引入就会报错
3 创建与.js同名的.d.ts文件,并为已存在变量定义类型
在,d.ts中只定义变量类型,不写方法等
4 .js文件引入成功