【速查手册】TypeScript 高级类型 cheat sheet

 阅读约 18 分钟

学习 TypeScript 到一定阶段,必须要学会高阶类型的使用,否则一些复杂的场景若是用 any 类型来处理的话,也就失去了 TS 类型检查的意义。

本文罗列了 TypeScript 常用的高阶类型,包含 官方 、以及 常用的非官方 的高级类型声明,该手册直接硬啃的话有些枯燥,适合平时快速查阅,使用 Ctrl+F 来查找关键词来定位即可。

1、基础

1.1、交叉类型

交叉类型是将 多个类型合并为一个类型。 这让我们可以把现有的多种类型叠加到一起成为一种类型,它包含了所需的所有类型的特性。

Person & Serializable & Loggable
  • 同时是 Person 和 Serializable 和 Loggable。
  • 就是说这个类型的对象同时拥有了这三种类型的成员

示例extend 融合方法

function extend<T, U>(first: T, second: U): T & U {
    let result = <T & U>{};
    for (let id in first) {
        (<any>result)[id] = (<any>first)[id];
    }
    for (let id in second) {
        if (!result.hasOwnProperty(id)) {
            (<any>result)[id] = (<any>second)[id];
        }
    }
    return result;
}

特殊情况:
T | never = T
T & never = never (which #16446 provides)

1.2、extends 关键字

T extends U ? X : Y

表示,如果 T 可以赋值给 U (类型兼容),则返回 X,否则返回 Y;

1.3、使用 keyofin

keyof 可以用来取得一个对象接口的所有 key 值:

interface Foo {
  name: string;
  age: number
}
type T = keyof Foo // -> "name" | "age"

in 则可以遍历枚举类型, 例如:

type Keys = "a" | "b"
type Obj =  {
  [p in Keys]: any
} // -> { a: any, b: any }

keyof 产生联合类型, in 则可以遍历枚举类型, 所以他们经常一起使用。

1.4、infer 关键字

infer 这个关键字是在 TS 2.8 版本引入的, 在条件类型语句中,该关键字用于替代手动获取类型

TypeScript 为此提供了一个示例,他们创建了一个叫作 Flatten 的类型,用于将数组转成他们需要的元素类型:

type Flatten<T> = T extends any[] ? T[number] : T;

如果使用关键字 infer 就可以将上面的代码简化成:

type Flatten<T> = T extends Array<infer U> ? U : T;

2、映射类型

2.1、Partial(官方)

作用:将传入的属性变为可选项

源码

type Partial<T> = { [P in keyof T]?: T[P] };

解释

  • keyof T 拿到 T 所有属性名
  • 然后 in 进行遍历, 将值赋给 P, 最后 T[P] 取得相应属性的值.
  • 结合中间的 ? 我们就明白了 Partial 的含义了.

扩展:内置的 Partial 有个局限性,就是只支持处理第一层的属性,如果是嵌套多层的就没有效果了,不过可以如下自定义:

type PowerPartial<T> = {
    // 如果是 object,则递归类型
    [U in keyof T]?: T[U] extends object
      ? PowerPartial<T[U]>
      : T[U]
};

2.2、Required(官方)

作用:将传入的属性变为必选项

源码

type Required<T> = { [P in keyof T]-?: T[P] };

解释

  • 我们发现一个有意思的用法 -?, 这里很好理解就是将可选项代表的 ? 去掉, 从而让这个类型变成必选项
  • 与之对应的还有个 +? , 这个含义自然与 -? 之前相反, 它是用来把属性变成可选项的

2.3、Readonly(官方)

作用:将传入的属性变为只读选项

源码

type Readonly<T> = { readonly [P in keyof T]: T[P] };

扩展:在 巧用 Typescript 中,作者创建了 DeepReadonly 的声明,使用 递归 的思想让任何子属性都不可更改

type DeepReadonly<T> = {
  readonly [P in keyof T]: DeepReadonly<T[P]>;
}

const a = { foo: { bar: 22 } }
const b = a as DeepReadonly<typeof a>
b.foo.bar = 33 // Hey, stop!

2.4、Mutable(第三方)

作用:将 T 的所有属性的 readonly 移除

源码

type Mutable<T> = {
  -readonly [P in keyof T]: T[P]
}

解释

  • 这一对加减符号操作符 +-, 进行的不是变量的之间的进行加减而是对 readonly 属性进行加减

2.5、Record(官方)

作用:将 K 中所有的属性的值转化为 T 类型

源码

type Record<K extends keyof any, T> = { [P in K]: T };

示例

// 对所有 T 类型的属性 K, 将它转换为 U
function mapObject<K extends string | number, T, U>(obj: Record<K, T>, f: (x: T) => U): Record<K, U>;

const names = { foo: "hello", bar: "world", baz: "bye" };
const lengths = mapObject(names, s => s.length);  // { foo: number, bar: number, baz: number }

2.6、Pick(官方)

作用:从 T 中取出 一系列 K 的属性

源码

type Pick<T, K extends keyof T> = { [P in K]: T[P] };

示例

// 从 T 挑选一些属性 K
declare function pick<T, K extends keyof T>(obj: T, ...keys: K[]): Pick<T, K>;

const nameAndAgeOnly = pick(person, "name", "age");  // { name: string, age: number }

3、条件类型

3.1、Exclude(官方)

某些地方也称为 Diff

作用:从 T 中剔除可以赋值给 U 的类型,换言之就是从T 中排除 U

源码

type Exclude<T, U> = T extends U ? never : T;

解释

  • 在 ts 2.8 中引入了一个条件类型, T extends U ? X : Y 表示如果 TU 的子类型的话,那么就会返回 X,否则返回 Y
  • 对于联合类型来说会自动分发条件,例如 T extends U ? X : Y, T 可能是 A | B 的联合类型, 那实际情况就变成(A extends U ? X : Y) | (B extends U ? X : Y)

示例

type T = Exclude<1 | 2, 1 | 3> // -> 2

参考文档

3.2、Extract(官方)

作用:从 T 中提取出包含在 U 的类型,换言之就是从T 中提取出 U 子集

源码

type Extract<T, U> = T extends U ? T : never;

示例

type T = Extract<1 | 2, 1 | 3> // -> 1

3.3、Omit (第三方)

作用:从 T 中忽略在 K 中的属性名 ,实现忽略对象某些属性功能,多在高阶组件中使用

源码

type Omit<T, K> = Pick<T, Exclude<keyof T, K>>

示例

type Foo = Omit<{name: string, age: number}, 'name'> // -> { age: number }

3.4、Overwrite(第三方)

作用T 中的定义被在 K 中的内容所覆盖,多在高阶组件中使用,内部借助 Diff 操作实现

源码

type Overwrite<T, U> = { [P in Exclude<keyof T, keyof U>]: T[P] } & U;

示例

type Item1 = { a: string, b: number, c: boolean };
type Item2 = { a: number };
type T3 = Overwrite<Item1, Item2> // { a: number, b: number, c: boolean };

3.5、ReturnType (官方)

作用:从 T 中忽略在 K 中的属性名 ,实现忽略对象某些属性功能,多在高阶组件中使用

源码

type ReturnType<T> = T extends (
  ...args: any[]
) => infer R
  ? R
  : any;

解释

  • 我们可以用 infer 声明一个类型变量,是用它获取函数的返回类型,简单说就是用它取到函数返回值的类型方便之后使用.

示例

function foo(x: number): Array<number> {
  return [x];
}
type fn = ReturnType<typeof foo>;

4、函数相关

4.1、ThisType(官方)

作用:用于指定上下文对象类型的

源码

// node_modules/typescript/lib/lib.es5.d.ts
interface ThisType<T> { }

解释

  • 可以看到声明中只有一个接口,没有任何的实现
  • 说明这个类型是在 TS 源码层面支持的,而不是通过类型变换。

示例

interface Person {
    name: string;
    age: number;
}

const obj: ThisType<Person> = {
  dosth() {
    this.name // string
  }
}

这样的话,就可以指定 obj 里的所有方法里的上下文对象改成 Person 这个类型了

4.2、InstanceType(官方)

作用:用于获取构造函数类型的实例类型

源码

// node_modules/typescript/lib/lib.es5.d.ts

type InstanceType<T extends new (...args: any[]) => any> = T extends new (...args: any[]) => infer R ? R : any;

解释

  • 使用 inferextends 条件判断完成

示例

class C {
    x = 0;
    y = 0;
}

type T20 = InstanceType<typeof C>;  // C
type T21 = InstanceType<any>;  // any
type T22 = InstanceType<never>;  // any
type T23 = InstanceType<string>;  // Error
type T24 = InstanceType<Function>;  // Error

这样的话,就可以指定 obj 里的所有方法里的上下文对象改成 Person 这个类型了

4.3、NonNullable(官方)

作用:这个类型可以用来过滤类型中的 null 及 undefined 类型。

源码

// node_modules/typescript/lib/lib.es5.d.ts

type NonNullable<T> = T extends null | undefined ? never : T;

解释

  • 使用 extends 条件判断完成

示例

type T22 = string | number | null;
type T23 = NonNullable<T22>; // -> string | number;

4.4、Parameters(官方)

作用:该类型可以获得函数的参数类型组成的元组类型。

源码

// node_modules/typescript/lib/lib.es5.d.ts

type Parameters<T extends (...args: any[]) => any> = T extends (...args: infer P) => any ? P : never;

解释

  • 使用 inferextends 条件判断完成

示例

function foo(x: number): Array<number> {
  return [x];
}

type P = Parameters<typeof foo>; // -> [number]

此时 P 的真实类型就是 foo 的参数组成的元组类型 [number]

4.5、ConstructorParameters(官方)

作用:获得类的参数类型组成的元组类型。

源码

// node_modules/typescript/lib/lib.es5.d.ts

type ConstructorParameters<T extends new (...args: any[]) => any> = T extends new (...args: infer P) => any ? P : never;

解释

  • 使用 inferextends 条件判断完成

示例

class Person {
  private firstName: string;
  private lastName: string;
  
  constructor(firstName: string, lastName: string) {
      this.firstName = firstName;
      this.lastName = lastName;
  }
}

type P = ConstructorParameters<typeof Person>; // -> [string, string]

此时 P 就是 Personconstructor 的参数 firstNamelastName 的类型所组成的元组类型 [string, string]

下面的是我的公众号二维码图片,欢迎关注。
个人微信公众号

阅读 1.2k更新于 2019-06-26

推荐阅读
JSCON简时空
用户专栏

任何时候开始学都不算晚,任何时候开始学都已经不早了

705 人关注
20 篇文章
专栏主页
目录