typescript 枚举键值动态 typescript 枚举的作用

转载

mob64ca1403c772 2024-02-04 06:42:39

文章标签 typescript 枚举键值动态学习 typescript javascript 泛型 文章分类 TypeScript 前端开发

枚举-基本使用

目标

掌握枚举类型的使用

定义

enum，枚举。它用来描述一个值，该值只能是一组命名常量中的一个

没有type之前，用枚举比较多，现在用的少了。枚举的功能类似于字面量类型+联合类型组合的功能，也可以表示一组明确的可选值

格式

定义格式

enum 枚举名 { 可取值1,可取值2,.. }

说明：

使用 enum 关键字定义枚举
一般约定首字符大写

使用格式

枚举名.可取值

示例

// 定义枚举类型
enum Direction { Up, Down, Left, Right }

// 使用枚举类型
function changeDirection(direction: Direction) {
  console.log(direction)
}

// 调用函数时，需要应该传入：枚举 Direction 成员的任意一个
// 类似于 JS 中的对象，直接通过 点（.）语法 访问枚举的成员
changeDirection(Direction.Up)

解释:

约定枚举名称以大写字母开头
枚举中的多个值之间通过 ,（逗号）分隔
定义好枚举后，直接使用枚举名称作为类型注解

枚举-枚举的值

目标

掌握枚举类型的值

枚举的值

枚举类型和ts中其他的类型不一样，枚举类型不仅仅是类型，还是一个值。

type定义的类型是没有值的

type NewType = number | string
console.log(NewType)  // 输出类型是没有意义的

枚举定义的类型是有值的。

// 创建枚举
enum Direction { Up, Down, Left, Right }

// 调用函数时，需要应该传入：枚举 Direction 成员的任意一个
// 类似于 JS 中的对象，直接通过 点（.）语法 访问枚举的成员
console.log(Direction.Up)

也可以使用tsc给编译一下来做对比

数字枚举

默认情况下，枚举的值是数值。默认为：从 0 开始自增的数值

当然，也可以给枚举中的成员初始化值

// Down -> 11、Left -> 12、Right -> 13
enum Direction { Up = 10, Down, Left, Right }

enum Direction { Up = 2, Down = 4, Left = 8, Right = 16 }

字符串枚举

字符串枚举：枚举成员的值是字符串

enum Direction {
  Up = 'UP',
  Down = 'DOWN',
  Left = 'LEFT',
  Right = 'RIGHT'
}

注意：字符串枚举没有自增长行为，因此，字符串枚举的每个成员必须有初始值

小结

枚举与前面讲到的字面量类型+联合类型组合的功能类似，都用来表示一组明确的可选值列表
一般情况下，推荐使用字面量类型+联合类型组合的方式，因为相比枚举，这种方式更加直观、简洁、高效

枚举类型的应用

用后端用0,1来标识性别，但是0，1在代码中不好读。

enum Gender {
        girl,
        boy
    }
    type User = {
        name: string,
        gender: Gender
    }

    const u1: User = {
        name: '小花',
        gender: Gender.girl
    }

    console.log(u1)

any 类型

目标

掌握any类型的使用

定义及作用

any: 任意的。当类型设置为 any 时，就取消了类型的限制。

let obj: any = { x: 0 }

obj.bar = 100
obj()
const n: number = obj

解释: 以上操作都不会有任何类型错误提示，即使可能存在错误（编译时不报错，可是运行时会报错）

使用any的场景

函数就是不挑类型。例如，console.log() ；定义一个函数，输入任意类型的数据，返回该数据类型
临时使用 any 来“避免”书写很长、很复杂的类型

隐式 any

声明变量不提供类型也不提供默认值
定义函数时，参数不给类型

小结

原则:不推荐使用 any!这会让 TypeScript 变为 “AnyScript”(失去 TS 类型保护的优势)

类型断言

问题导入

假设我们明确知道页面上有一个img，它的id是img。

const box = document.getElementById('img')
console.log(box.src) // ts报错

注意：该方法返回值的类型是 HTMLElement，该类型只包含所有标签公共的属性或方法，不包含 img 标签特有的 src等属性，无法操作 src 等 img标签特有的属性或方法。

类型断言的作用和应用场景

作用：手动指定值的类型

场景：有时候你会比 TS 更加明确一个值的类型，此时，可以使用类型断言来指定更具体的类型。

格式

关键字： as

const 变量 = 值 as 类型

解释:

使用 as 关键字实现类型断言
关键字 as 后面的类型是一个更加具体的类型（HTMLAnchorElement 是 HTMLElement 的子类型）

示例1

const box = document.getElementById('img') as HTMLImageElement

box.src

技巧：如何得知dom的类型

在浏览器控制台，通过 __proto__ 获取 DOM 元素的类型;
document.createElement(‘a’)，然后看代码提示

示例2

知道后端的结果会是一个类型，但这个结果是用ajax拿到的，不好直接给初始值，又希望得到输出提示的效果

type User = {
  name: string,
  age: number
}

const u1 = {} as User

console.log(u1.name) // 这里就会有提示

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-yul8lwKu-1652531778014)(asset/image-20211125102525400.png)]

typeof

问题导入

res表示一个复杂的对象，我们把它传给一个函数fn，但是目前没有办法从形参obj中获取提示信息

const res = { name: '小花', city: '武汉',  skills: ['js', 'css'] }

function fn(obj) {
  // 这里写obj.没有提示
  // obj.
}

fn(res)

怎么解决？

typeof

JS 中提供了 typeof 操作符，用来在 JS 中获取数据的类型

console.log(typeof 'Hello world') // ?

TS 也提供了 typeof 操作符：可以用来获取变量或属性的类型

使用场景

根据已有变量的值，反向推断出获取该值的类型，来简化类型书写

格式

type 类型 = typeof 常量

示例

const res = { name: '小花', city: '武汉',  skills: ['js', 'css'] }

type Stu = typeof res

function fn(obj:Stu) {
    // 这里写 obj. 就会有提示
    obj.skills
}

fn(res)

解释:

使用 typeof 操作符来获取变量 p 的类型，结果与第一种（对象字面量形式的类型）相同
typeof 出现在类型注解的位置（参数名称的冒号后面）所处的环境就在类型上下文(区别于 JS 代码)
注意：typeof 只能用来查询变量或属性的类型，无法查询其他形式的类型（比如，函数调用的类型）

keyof

约定类型是某个对象/类型的属性名

格式

type 类型 = keyof 类型
type 类型 = keyof 对象常量

示例

type Point = { x: number; y: number };
type P = keyof Point;

type T = keyof {a:1,b:2}

_{基本类型学习完了}

泛型-基本介绍

需求

创建一个 fn 函数，它的特点是：传入什么类型（可能有多种类型）的数据就返回什么类型的数据。也就是说，参数和返回值类型相同。

例如：

function fn(value: number): number { return value }

比如，fn(10) 调用以上函数就会直接返回 10 本身。但是，该函数声明只接收数值类型，无法用于其他类型

思考：any 能做到么？

function fn(value: any): any { return value }

不能。它没有了类型保护，也没有严格限制返回值的类型和输入值的类型一致。

泛型

泛型，顾名思义，就是可以适用于多个类型，使用类型变量（比如T）帮助我们捕获传入的类型，之后我们就可以继续使用这个类型。

本质是参数化类型，通俗的讲，就是所操作的数据类型被指定为一个参数，这种参数类型可以用在类、接口和函数的创建中，分别成为泛型类，泛型接口、泛型函数

泛型函数：这个函数的参数类型或者返回值的类型是可变的

泛型-泛型函数

定义格式

function 函数名<类型变量1,类型变量2,...>(参数1:类型1,参数2:类型2,...): 返回值类型 {
  
}

在函数名称的后面写 <>(尖括号)，尖括号中添加类型变量

类型变量相当于一个类型容器，能够捕获用户提供的类型(具体是什么类型由用户调用该函数时指定)

示例

function fn<Type>(value: Type): Type { return value }
// 上面的Type只是一个名字而已，可以改成其他的，例如T

function fn<T>(value: T): T { return value }

类型变量 Type，是一种特殊类型的变量，它处理类型而不是值
因为 Type 是类型，因此可以将其作为函数参数和返回值的类型，表示参数和返回值具有相同的类型
类型变量 Type，可以是任意合法的变量名称

调用格式

const 返回值  = 泛型函数名<类型1，类型2,...>(实参1，实参2,实参3,......)

语法：在函数名称的后面添加 <>(尖括号)，尖括号中指定具体的类型

示例

const num = fn<number>(10)
const str = fn<string>('a')

当传入类型 number 后，这个类型就会传递给函数声明时对应的类型变量
通过泛型就做到了让 fn 函数与多种不同的类型一起工作，实现了复用的同时保证了类型安全

小结

泛型函数的格式？
泛型函数的作用？

泛型-类型推断简化函数调用

问题

调用函数时，需要显示设置类型参数，太麻烦，

const num = fn<number>(10)

类型推断简化函数调用

function fn<T>(value: T): T { return value }

// 省略 <number> 调用函数
let num = fn(10)
let str = fn('a')

在调用泛型函数时，可以省略 <类型> 来简化泛型函数的调用
此时，TS 内部会采用一种叫做类型参数推断的机制，来根据传入的实参自动推断出类型变量 Type 的类型
比如，传入实参 10，TS 会自动推断出变量 num 的类型 number，并作为 Type 的类型

小结

推荐：使用这种简化的方式调用泛型函数，使代码更短，更易于阅读

泛型-练习

模拟实现useState的声明

要求说明

{
    // useState它接收一个任意类型的数据，返回一个数组。
    // 数组的第一个元素的类型与入参一致； 
    // 数组的第二个元素是一个函数
    //     函数的入参类型和返回值类型与useState的入参一致
    // react 
    // const [num, setNum] = useState(0)
    // const [str, setStr] = useState('ab')

    function useState(value) {
        const setValue = () => {

        }

        return [value, setValue]
    }

    const [str, setStr] = useState('123')

    const [num, setNum] = useState(123)
}

要求：鼠标放上去有对应的提示

参考

function useState<T>(p:T): [T,(p:T)=>T] {
  const t = (p: T):T => {
    return p
  }
  return [p, t]
}

泛型-泛型约束

目标

掌握泛型约束的原因及实现方式

泛型的问题

默认情况下，泛型函数的类型变量 T 可以代表多个类型，这导致在泛型函数内部无法访问任何属性

比如，fn(‘a’) 调用函数时获取参数的长度：

function fn<T>(value: T): T {
  // 这里value. 不会有提示
  console.log(value.length)// 这里会报错
  return value
}

fn('a')

T可以代表任意类型，无法保证一定存在 length 属性，比如 number 类型就没有 length

此时，就需要为泛型添加约束来收缩类型(缩窄类型取值范围),从而得到类型提示

添加泛型约束

添加泛型约束收缩类型，主要有以下两种方式：

指定更加具体的类型
添加约束

指定更加具体的类型

比如，从任意类型的数据 -----> 任意类型的数组。

将类型修改为 Type[](Type 类型的数组)，因为只要是数组就一定存在 length 属性，因此就可以访问了

function fn<T>(value: T[]): T[] {
  console.log(value.length) // 这里就可以获得提示
  return value
}

添加约束

比如，要求传入T类型必须要有length属性。

思路

对已有类型做继承

// 创建一个接口
interface ILength { length: number }

类型参数继承接口

// 类型参数继承接口
// T extends ILength 添加泛型约束
function fn<T extends ILength>(value: T): T {
  console.log(value.length)
  return value
}

fn('abc') // Ok
fn([1,2,3]) // Ok

解释:

创建描述约束的接口 ILength，该接口要求提供 length 属性
通过 extends 关键字使用该接口，为泛型(类型变量)添加约束
T extends ILength约束表示：传入的类型必须具有 length 属性

注意:传入的实参(比如，数组)只要有 length 属性即可（类型兼容性)

示例

function setElement<Type extends HTMLElement>(element:Type):Type {
  console.log(element.innerText) // 这里的.会有语法提示
  return element
}

泛型-典型应用

比如，创建一个函数来获取对象中属性的值

// 对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

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-F8pBGI2K-1652531778016)(asset/image-20210917002203414.png)]

解释:当我们在使用数组时，TS 会根据数组的不同类型，来自动将类型变量设置为相应的类型
技巧:可以通过 Ctrl + 鼠标左键(Mac：Command + 鼠标左键)来查看具体的类型信息

泛型工具类型

泛型工具类型:TS 内置了一些常用的工具类型，来简化 TS 中的一些常见操作

说明:它们都是基于泛型实现的(泛型适用于多种类型，更加通用)，并且是内置的，可以直接在代码中使用。这些工具类型有很多，先来学习以下3个:

Partial<Type>
Readonly<Type>
Pick<Type, Keys>

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, Keys> 从 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 }

引入使用

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-MrcHGzGP-1652531778017)(asset/image-20211125160810583.png)]

类型声明文件的使用说明

目标

掌握类型声明文件的概念和使用

作用

类型声明文件：用来为已存在的 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…

这类库没有自带声明文件，需要我们单独去下载。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-rbDHPb4w-1652531778018)(asset/image-20211124202810874.png)]

下载库声明文件

命令：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
}

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。