TS内置工具类型 Exclude、Extract 、Pick 和 Omit

279 阅读3分钟

Exclude 排除

Exclude<UnionType, ExcludedMembers>

UnionType中去掉所有能够赋值给ExcludedMembers的属性,然后剩下的属性构成一个新的类型
Constructs a type by excluding from UnionType all union members that are assignable to ExcludedMembers.

type T0 = Exclude<"a" | "b" | "c", "a">;

Extract 提取

Extract<Type, Union>

提取Type中所有能够赋值给Union的属性,将这些属性构成一个新的类型
Constructs a type by extracting from Type all union members that are assignable to Union.

type T0 = Extract<"a" | "b" | "c", "a" | "f">;

Pick 选择

Pick<Type, Keys>

从Type中选取一系列的属性,这些属性来自于Keys(字符串字面量或字符串字面量的联合类型),用这些属性构成新的type。
Constructs a type by picking the set of properties Keys (string literal or union of string literals) from Type.

type Test = {
  name: string;
  age: number;
  salary?: number;
};

//pick
type picked = Pick<Test, "name" | "age">;
// 结果
// type picked = {
//     name: string;
//     age: number;
// }

Omit

这是一个使用 type 类型别名定义的 User 类型,用于描述用户对象

type User = {
  id: string; // 用户id
  name: string; // 用户名
  password: string; // 密码
  createdAt: Date; // 创建时间
  updatedAt: Date; // 更新时间
};

其中 id、createdAt 和 updatedAt 这些属性是在创建用户时,由服务端自动生成的。因此在注册用户时,用于描述注册用户对象的 RegisterUser 类型并不需要以上这些属性。那么我们应该如何高效地定义 RegisterUser 类型呢?这时我们可以使用 TS 内置的 Omit 工具类型。

type RegisterUser = Omit<User, "id" | "createdAt" | "updatedAt">;
type RegisterUser = {
    name: string;
    password: string;
}

由以上结果可知,id、createdAt 和 updatedAt 这些属性都已经被过滤掉了,所以使用 Omit 工具类型,我们可以很方便地过滤掉对象类型中不需要的属性。

其实 Omit 工具类型还有其它的作用,比如我们可以利用接口继承的方式来实现覆盖已有对象类型中已知属性的类型。具体的实现方式也很简单:

interface UserUI extends Omit<User, "createdAt" | "updatedAt"> {
  createdAt: string;
  updatedAt: string;
}

UserUI 接口描述的对象用于在页面上显示用户信息,所以我们把原有 User 类型中 createdAt 和 updatedAt 属性的类型都修改成 string 类型。

了解完 Omit 工具类型的应用场景,下面我们来看一下它内部是如何实现的。

// typescript/lib/lib.es5.d.ts
type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;

由以上代码可知,Omit 工具类型内部使用了 TS 内置的 Pick 和 Exclude 工具类型。

其中 keyof 操作符用于获取某种类型中的所有键,其返回类型是联合类型。而 Exclude 工具类型用于实现类型过滤,即从 keyof T 返回的联合类型中,过滤掉要排除的属性。最终再使用 Pick 工具类型从原有的对象类型中,挑选出需保留的属性,组合成新的对象类型。

Omit和Exclude的区别

结论:[泛型]的参数不一样

  • Omit< key:value,key>
    作用:基于已经声明的类型进行属性剔除获得新类型 用例:
type User = {

id: string;

name: string;

email: string;

};

type UserWithoutEmail = Omit<User, "email">;// UserWithoutEmail ={id: string;name: string;}


  • Exclude< T, U > 作用:T中取T、U交集的补集 与Omit作比较:

Omit左右两个参数属于不同类型,左是一个完整的类型,包含key、value Exclude左右两个参数属于同种类型 用例:

       type T0 = Exclude<"a" | "b" | "c", "a">;      
       // "b" | "c"
       type T1 = Exclude<"a" | "b" | "c", "a" | "b">;     
       // "c"
       type T2 = Exclude<string | number | (() => void), Function>; 
       // string | number

相同点:

  1. 两种工具类都是使用已有的类型进行属性过滤获得新的类型
  2. Omit和Exclude都是做属性剔除

不同点:

  1. Exclude的参数类型没有限制,可以是字面量也可以是具体的类型如string、boolean等,而Omit的第二参数则必须是第一参数的子属性

Pick搭配Exclude实现OmitExclude先剔除不要的键名,挑出想要的键名,Pick再从键值对中根据键名挑选出来。

实现公式:Omit=Pick<T,Exclude<keyof T,K>>。