目录

• 简介
• Script 与 Vue3
• defineProps 与 Typescript
• defineEmits 与 Typescript
• ref 与 Typescript
• computed 与 Typescript
• 事件对象 与 Typescript
• 模板 Ref 与 Typescript
• 可选链操作符
• 非空断言-TS
• TypeScript类型声明文件
• 基本介绍
• 内置类型声明文件
• 第三方库类型声明文件
• 自定义类型声明文件

简介

声明文件是以.d.ts为后缀的文件，开发者在声明文件中编写类型声明，TypeScript根据声明文件的内容进行类型检查。（注意同目录下最好不要有同名的.ts文件和.d.ts，例如lib.ts和lib.d.ts，否则模块系统无法只根据文件名加载模块）

为什么需要声明文件呢？我们知道TypeScript根据类型声明进行类型检查，但有些情况可能没有类型声明：

• 第三方包，因为第三方包打包后都是JavaScript语法，而非TypeScript，没有类型。
• 宿主环境扩展，如一些hybrid环境，在window变量下有一些bridge接口，这些接口没有类型声明。

Script 与 Vue3

参考链接（英文）：vuejs.org/guide/types…

参考链接（中文）：staging-cn.vuejs.org/guide/types…

vue3配合ts中，还需要额外安装一个 vscode 插件：Typescript Vue Plugin

defineProps 与 Typescript

目标：掌握defineProps如何配合ts使用

• defineProps配合vue默认语法进行类型校验（运行时声明）

// 运行时声明
defineProps({
  money: {
    type: Number,
    required: true
  },
  car: {
    type: String,
    required: true
  }
})

• defineProps配合ts的泛型定义props类型校验，这样更直接

// 使用 ts 的泛型指定 props 类型
defineProps<{
  money: number
  car?: string
}>()

• props 可以通过解构来指定默认值

<script lang="ts" setup>
// 使用ts的泛型指令props类型
const { money, car = '小黄车' } = defineProps<{
  money: number
  car?: string
}>()
</script>

如果提供的默认值需要在模板中渲染，需要额外添加配置

vuejs.org/guide/extra…

// vite.config.js
export default {
  plugins: [
    vue({
      reactivityTransform: true
    })
  ]
}

defineEmits 与 Typescript

目标：掌握 defineEmits 如何配合ts使用

• defineEmits 配合运行时声明

const emit = defineEmits(['change', 'update'])

• defineEmits配合ts 类型声明，可以实现更细粒度的校验

const emit = defineEmits<{
  (e: 'changeMoney', money: number): void
  (e: 'changeCar', car: string): void
}>()

ref 与 Typescript

目标：掌握ref配合ts如何使用

• 通过泛型指定value的值类型，如果是简单值，该类型可以省略

const money = ref<number>(10)
// 推荐写法，提供效率
const money = ref(10)

• 如果是复杂类型，泛型指定

interface Todo {
  id: number
  content: string
  done: boolean
}
// 复杂类型需要指定结构，不能省略
const list = ref<Todo[]>([])
list.value.push({ id: 1, content: '吃饭', done: false })

computed 与 Typescript

目标：掌握computed配合typescript如何使用

• 通过泛型可以指定computed计算属性的类型，通常可以省略

const leftCount = computed<number>(() => {
  return list.value.filter((v) => v.done).length
})
console.log(leftCount.value)

事件对象 与 Typescript

目标：掌握事件处理函数配合typescript如何使用

const btn = (e: MouseEvent) => {
  mouse.value.x = e.pageX
  mouse.value.y = e.pageY
}
<h2 @click="btn($event)">根组件</h2>

模板 Ref 与 Typescript

目标：掌握ref操作DOM时如何配合Typescript使用

const imgRef = ref<HTMLImageElement | null>(null)
onMounted(() => {
  console.log(imgRef.value?.src)
})

如何查看一个DOM对象的类型：通过控制台进行查看

document.createElement('img').__proto__

可选链操作符

**目标：**掌握js中的提供的可选链操作符语法

内容

• 可选链操作符( ?. )允许读取位于连接对象链深处的属性的值，而不必明确验证链中的每个引用是否有效。
• 参考文档：developer.mozilla.org/zh-CN/docs/…

let nestedProp = obj.first?.second;
console.log(res.data?.data)
obj.fn?.()

if (obj.fn) {
    obj.fn()
}
obj.fn && obj.fn()

// 等价于
let temp = obj.first;
let nestedProp = ((temp === null || temp === undefined) ? undefined : temp.second);

非空断言-TS

目标：掌握ts中的非空断言的使用语法

内容：

• 如果我们明确的知道对象的属性一定不会为空，那么可以使用非空断言 !

// 告诉 typescript, 明确的指定obj不可能为空
let nestedProp = obj!.second;

• 注意：非空断言一定要确保有该属性才能使用，不然使用非空断言会导致bug

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 文件提供该类型，实现类型共享。
• 操作步骤:

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

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

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

为已有 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 关键字，明确指定此处用于类型声明。

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 }

定义类型声明文件

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
}