【TypeScript】TS类型声明文件

项目内共享类型如果多个 .ts 文件中都用到同一个类型，此时可以创建 .d.ts 文件提供该类型，实现类型共享。Props } from './index' //通过import导入 // type Props = { x: number;Props } from './index' //通过import导入 // type Props = { x: number;x : number;Props

itpeilibo

3185人浏览 · 2023-01-19 09:29:16

itpeilibo · 2023-01-19 09:29:16 发布

🧑‍💻TypeScript类型声明文件

文章目录

🧑‍💻TypeScript类型声明文件

🧑‍💻基本介绍

今天几乎所有的 JavaScript 应用都会引入许多第三方库来完成任务需求。
这些第三方库不管是否是用 TS 编写的，最终都要编译成 JS 代码，才能发布给开发者使用。
我们知道是 TS 提供了类型，才有了代码提示和类型保护等机制。

但在项目开发中使用第三方库时，你会发现它们几乎都有相应的 TS 类型，这些类型是怎么来的呢? 类型声明文件

类型声明文件：用来为已存在的 JS 库提供类型信息
TS 中有两种文件类型：1 .ts 文件 2 .d.ts 文件
.ts 文件:

既包含类型信息又可执行代码
可以被编译为 .js 文件，然后，执行代码
用途：编写程序代码的地方

.d.ts 文件:

只包含类型信息的类型声明文件
不会生成 .js 文件，仅用于提供类型信息,在.d.ts文件中不允许出现可执行的代码，只用于提供类型
用途：为 JS 提供类型信息

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

🧑‍💻内置类型声明文件

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

const strs = ['a', 'b', 'c']
// 鼠标放在 forEach 上查看类型
strs.forEach

实际上这都是 TS 提供的内置类型声明文件
可以通过 Ctrl + 鼠标左键(Mac：Command + 鼠标左键)来查看内置类型声明文件内容
比如，查看 forEach 方法的类型声明，在 VSCode 中会自动跳转到 lib.es5.d.ts 类型声明文件中
当然，像 window、document 等 BOM、DOM API 也都有相应的类型声明(lib.dom.d.ts)

🧑‍💻第三方库类型声明文件

目前，几乎所有常用的第三方库都有相应的类型声明文件
第三方库的类型声明文件有两种存在形式:1 库自带类型声明文件 2 由 DefinitelyTyped 提供。

库自带类型声明文件：比如，axios

查看 node_modules/axios 目录

解释：这种情况下，正常导入该库，TS 就会自动加载库自己的类型声明文件，以提供该库的类型声明。

由 DefinitelyTyped 提供

DefinitelyTyped 是一个 github 仓库，用来提供高质量 TypeScript 类型声明
DefinitelyTyped 链接
可以通过 npm/yarn 来下载该仓库提供的 TS 类型声明包，这些包的名称格式为:@types/*
比如，@types/react、@types/lodash 等
说明：在实际项目开发时，如果你使用的第三方库没有自带的声明文件，VSCode 会给出明确的提示

import _ from 'lodash'

// 在 VSCode 中，查看 'lodash' 前面的提示

解释：当安装 @types/* 类型声明包后，TS 也会自动加载该类声明包，以提供该库的类型声明
补充：TS 官方文档提供了一个页面，可以来查询 @types/* 库
@types/* 库

🧑‍💻自定义类型声明文件-共享数据

项目内共享类型

如果多个 .ts 文件中都用到同一个类型，此时可以创建 .d.ts 文件提供该类型，实现类型共享。

// a.ts
import { Props } from './index'  //通过import导入
// type Props = { x: number; y: number }

let p1: Props = {
  x: 1,
  y: 2
}

// b.ts
import { Props } from './index'  //通过import导入
// type Props = { x: number; y: number } 

let p2: Props = {
  x: 12,
  y: 24
}

// index.d.ts
type Props = { x: number; y: number }
export { Props }  //创建需要共享的类型，并使用export导出

操作步骤:

创建 index.d.ts 类型声明文件。
创建需要共享的类型，并使用 export 导出(TS 中的类型也可以使用 import/export 实现模块化功能)。
在需要使用共享类型的 .ts 文件中，通过 import 导入即可(.d.ts 后缀导入时，直接省略)。

自定义类型声明文件-为js提供声明

为已有 JS 文件提供类型声明

在将 JS 项目迁移到 TS 项目时，为了让已有的 .js 文件有类型声明。
成为库作者，创建库给其他人使用。

演示:基于最新的 ESModule(import/export)来为已有 .js 文件，创建类型声明文件。

类型声明文件的使用说明

说明:TS 项目中也可以使用 .js 文件。
说明:在导入 .js 文件时，TS 会自动加载与 .js 同名的 .d.ts 文件，以提供类型声明。
declare 关键字:用于类型声明，为其他地方(比如，.js 文件)已存在的变量声明类型，而不是创建一个新的变量。

对于 type、interface 等这些明确就是 TS 类型的(只能在 TS 中使用的)，可以省略 declare 关键字。
对于 let、function 等具有双重含义(在 JS、TS 中都能用)，应该使用 declare 关键字，明确指定此处用于类型声明。

// index.ts文件
//导入.js文件时，自动加载.js文件的类型声明文件.d.ts,然后就能用到声明好的类型了
import { count, songName, add, Point} from './utils'

type Person = {
  name: string
  age: number
}

let p：Partial<Person> = {
  name: 'itpeilibo'
}

let p1: Point = {
  x: 10,
  y: 20
}
console.log('项目启动了')
console.log('count', count)
console.log('songName', songName)
console.log('add()', add(1, 4))

//utils.js文件
let count = 10
let songName = '巨人的小脚丫'
let position = {
  x: 0,
  y: 0
}

//函数声明形式
function add(x, y) {
  return x + y
}

function changeDirection(direction) {
  console.log(direction)
}

//函数表达式形式
const fomartPoint = point => {
  console.log('当前坐标：', point)
}

export { count, songName, position, add, changeDirection, fomartPoint }

定义类型声明文件

//utils.d.ts文件
//为utils.js文件来提供类型声明
declare let count:number //为已存在的变量声明类型

declare let songName: string

interface Position {
  x: number,
  y: number
}

declare let position: Position

declare function add (x :number, y: number) : number

type Direction = 'left' | 'right' | 'top' | 'bottom'

declare function changeDirection (direction: Direction): void
//自定义函数类型
type FomartPoint = (point: Position) => void

declare const fomartPoint: FomartPoint

export {
  count, songName, position, add, changeDirection, FomartPoint, fomartPoint
}