泛型-典型应用
比如,创建一个函数来获取对象中属性的值
// 对getProp函数进行改造 function getProp(obj, key) { return obj[key] } let person = { name: 'jack', age: 18 } getProp(person, 'name')
泛型的类型变量可以有多个,并且类型变量之间还可以约束(比如,第二个类型变量受第一个类型变量约束)
function getProp<Type, Key extends keyof Type>(obj: Type, key: Key) { return obj[key] } let person = { name: 'jack', age: 18 } getProp(person, 'name')
解释:
- 添加了第二个类型变量 Key,两个类型变量之间使用
,
逗号分隔。 - keyof 关键字接收一个对象类型,生成其键名称(可能是字符串或数字)的联合类型。
- 本示例中
keyof Type
实际上获取的是 person 对象所有键的联合类型,也就是:'name' | 'age'
- 类型变量 Key 受 Type 约束,可以理解为:Key 只能是 Type 所有键中的任意一个,或者说只能访问对象中存在的属性
// Type extends object 表示: Type 应该是一个对象类型,如果不是 对象 类型,就会报错 // 如果要用到 对象 类型,应该用 object ,而不是 Object function getProperty<Type extends object, Key extends keyof Type>(obj: Type, key: Key) { return obj[key] } getProperty({a:1, b:2}, 'a')
泛型接口
目标
掌握泛型接口的使用
泛型接口
在接口中使用泛型来使用,以增加其灵活性,增强其复用性
interface MyArray { length: number, push(n: number):void, pop():number, reverse():number[] } let obj: MyArray = { id(value) { return value }, ids() { return [1, 3, 5] } }
定义
interface 接口名<类型变量1,类型变量2...> { 属性名1:类型1, 属性名2:类型2, 属性名3:类型3 }
- 在接口名称的后面添加
<类型变量>
,那么,这个接口就变成了泛型接口。 - 接口的类型变量,对接口中所有其他成员可见,也就是接口中所有成员都可以使用类型变量。
- 使用泛型接口时,需要显式指定具体的类型
拓展
实际上,JS 中的数组在 TS 中就是一个泛型接口。
const strs = ['a', 'b', 'c'] // 鼠标放在 forEach 上查看类型 strs.forEach const nums = [1, 3, 5] // 鼠标放在 forEach 上查看类型 nums.forEach
- 解释:当我们在使用数组时,TS 会根据数组的不同类型,来自动将类型变量设置为相应的类型
- 技巧:可以通过 Ctrl + 鼠标左键(Mac:Command + 鼠标左键)来查看具体的类型信息
泛型工具类型
泛型工具类型:TS 内置了一些常用的工具类型,来简化 TS 中的一些常见操作
说明:它们都是基于泛型实现的(泛型适用于多种类型,更加通用),并且是内置的,可以直接在代码中使用。 这些工具类型有很多,先来学习以下3个:
Partial
Readonly
Pick
Partial
Partial用来基于某个Type来创建一个新类型,新类型中所有的属性是可选的。
格式
type OldType = {属性1:类型1,....} type NewType = Partial<OldType>
示例
用来构造(创建)一个类型,将 Type 的所有属性设置为可选。
type Props = { id: string children: number[] } type PartialProps = Partial<Props>
解释:构造出来的新类型 PartialProps 结构和 Props 相同,但所有属性都变为可选的。
Readonly
Readonly 用来构造一个类型,将 Type 的所有属性都设置为 readonly(只读)–不可修改。
示例:
type Props = { id: string children: number[] } type ReadonlyProps = Readonly<Props>
解释:构造出来的新类型 ReadonlyProps 结构和 Props 相同,但所有属性都变为只读的。
let props: ReadonlyProps = { id: '1', children: [] } // 错误演示 props.id = '2'
当我们想重新给 id 属性赋值时,就会报错:无法分配到 “id” ,因为它是只读属性。
Pick
Pick 从 Type 中选择一组属性来构造新类型。
示例:
type Props = { id: string title: string children: number[] } // 构造出来的新类型 PickProps,只有 id 和 title 两个属性类型。 type PickProps = Pick<Props, 'id' | 'title'>
解释:
- Pick 工具类型有两个类型变量:
- 表示选择谁的属性
- 表示选择哪几个属性
- 第二个类型变量传入的属性只能是第一个类型变量中存在的属性。
React-配合TS-创建新项目
目标
创建一个附带ts模板的react项目
命令
命令:npx create-react-app my-app --template typescript
说明:
在命令行中,添加 --template typescript
表示创建支持 TS 的项目
项目目录的变化
- 多了一个文件:
tsconfig.json
。在项目根目录下可以看到它,它就是TS 的配置文件 - 后缀名有变化。在 src 目录中,文件的后缀有变化,由原来的 .js 变为
.ts
或.tsx
.ts
ts 文件的后缀名.tsx
是在 TS 中使用 React 组件时,需要使用该后缀。只要文件中使用了jsx模板,后缀名必须叫tsx
- 在 src 目录中,多了
react-app-env.d.ts
文件.d.ts
类型声明文件,用来指定类型
三个文件后缀名
没有使用ts前:
.js
.jsx
// ts .ts: 不能包含模板-jsx .tsx:包含模板的代码,名字不能取.ts // .ts中可以有执行代码 + 类型声明 .d.ts .d.ts中只能出现类型声明
tsconfig的介绍
目标
了解tsconfig文件的作用
- tsconfig.json是typescript项目的配置文件,用于配置typescript
- tsconfig.json配置文件可以通过
tsc --init
生成 - 说明:所有的配置项都可以通过鼠标移入的方式,来查看配置项的解释说明。
- tsconfig 文档链接
{ // 编译选项 "compilerOptions": { // 生成代码的语言版本:将我们写的 TS 代码编译成哪个版本的 JS 代码 // 命令行: tsc --target es5 11-测试TS配置文件.ts "target": "es5", // ts内置的库 // 如果删除了dom库,则无法使用document.getElementById "lib": ["dom", "dom.iterable", "esnext"], // 允许 ts 编译器编译 js 文件 // 允许 import js文件 "allowJs": true, // 跳过类型声明文件的类型检查 "skipLibCheck": true, // es 模块 互操作,屏蔽 ESModule 和 CommonJS 之间的差异 "esModuleInterop": true, // 即使模块没有显式指定 default 导出,也允许通过 import x from 'y' "allowSyntheticDefaultImports": true, // 开启严格模式 "strict": true, // 对文件名称强制区分大小写 Demo.ts "forceConsistentCasingInFileNames": true, // 为 switch 语句启用错误报告 // 如果switch中没有break 或者 return 就报错 "noFallthroughCasesInSwitch": true, // 生成代码的模块化标准 "module": "esnext", // 模块解析(查找)策略 "moduleResolution": "node", // 允许导入扩展名为.json的模块 "resolveJsonModule": true, // 是否将没有 import/export 的文件视为旧(全局而非模块化)脚本文件 "isolatedModules": true, // 编译时不生成任何文件(只进行类型检查) "noEmit": true, // 指定将 JSX 编译成什么形式 "jsx": "react-jsx" }, // 指定允许 ts 处理的目录 "include": ["src"] }
小结
tsconfig.json是对ts的配置
可以通过官网来查看具体说明
创建并使用第一个ts文件
目标
创建并使用第一个ts文件
let a = 100 let arr = [1,2,3] export { a, arr }
类型声明文件的使用说明
目标
掌握类型声明文件的概念和使用
作用
类型声明文件:用来为已存在的 JS 库提供类型信息
示例
例如: 以 axios为例,先安装axios,再引入axios
import axios from 'axios' // 这里导入的是一个.js文件
为啥axios.get()有提示呢?
因为
在package.json中有一个配置:
types: "./index.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
)
类型声明-第三方库的类型声明文件
目标
了解第三方库没有类型声明文件的情况
自带类型声明的库
例如:axios
这种库无需做额外处理,可以直接使用代码提示功能
不带类型声明的库
例如:jquery, react…
这类库没有自带声明文件,需要我们单独去下载。
下载库声明文件
命令:npm i @types/库名
例如: npm i @types/jquery
参考
在https://www.typescriptlang.org/dt/search?search=中搜索
小结
- 并不是所有的第三方库都有提供ts的声明文件
- 没有类型声明文件只是没有代码提示,并不会导致功能不可使用
- 没有自带类型声明文件的库,我们要自己下载
类型声明-自定义的文件
目标
掌握对自定义文件提供类型声明文件
场景
如下两种场景需要提供类型声明文件
- 项目内共享类型
- 为已有 JS 文件提供类型声明
项目内共享类型
文件目录:
a.ts b.ts
文件内容:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-pOQLxRSg-1652531778018)(asset/image-20211026220542921-1637713839941.png)]
改进
将公共的类型定义提取出来,写在index.d.ts文件中
index.d.ts a.ts b.ts
index.d.ts
定义接口,并导出
export interface Token { token: string refresh_token: string }
a.js
导入接口并使用
import { Token } from './index' // 必须省略.d.ts function showToken(token: )
小结
- 如果多个 .ts 文件中都用到同一个类型,此时可以创建 .d.ts 文件提供该类型声明
- 步骤:
- 创建 index.d.ts 类型声明文件
- 创建需要共享的类型,并使用 export 导出(TS 中的类型也可以使用 import/export 实现模块化功能)。
- 在需要使用共享类型的 .ts 文件中,通过 import 导入即可(.d.ts 后缀导入时,直接省略)。
类型声明-自定义的文件-为已有 JS 文件提供类型声明
背景
有一个ts项目,用到了.js文件。
项目中ts和js同时存在,且不想将.js改成.ts
demo.ts utils/index.js
utils/abc.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 }
demo.ts
import { add } from './utils' // 这里可以使用,但是,没有提示。
这里可以使用,但是,没有提示
如何基于现有的.js提供声明文件?
思路:编写同名的.d.ts文件
demo.ts utils/index.js utils/index.d.ts // 这里是重点
定义类型声明文件
- 它的作用是提供声明,不需要提供逻辑代码;
- declare 关键字:用于类型声明,为其他地方(比如,.js 文件)已存在的变量声明类型,而不是创建一个新的变量。
- 对于 type、interface 等这些明确就是 TS 类型的(只能在 TS 中使用的),可以省略 declare 关键字。
- 对于 let、function 等具有双重含义(在 JS、TS 中都能用),应该使用 declare 关键字,明确指定此处用于类型声明。
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 }