使用Omit减少TS重复代码

455 阅读2分钟

Omit 工具类型的应用场景

Omit是Typescript新增的一个辅助类型,它的作用主要是:以一个类型为基础支持剔除某些属性,然后返回一个新类型。

这里使用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 类型中 createdAtupdatedAt 属性的类型都修改成 string 类型。

内部实现

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

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

keyof User ---> "id"|"name"|"password"|"createdAt"|"updatedAt"
Exclude<keyof User, "id"|"updatedAt"> ---> "name"|"password"|"createdAt"//keys
Pick<User, keys>

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