天天看点

TypeScript高级的用法Partial、Required、Readonly

TypeScript高级的用法Partial、Required、Readonly

如何让一个类的属性全部可选?

比如我有下面这样一个类型:

type User = {
  username: string;
  gender: 'male' | 'female';
  age: number;
  bio: string;
  password: string;
}      

User 类型要求所有属性都必须有值,所以:

const user: User = {
  username: 'awesomeuser',
};      

是不可行的,会提示:

类型“{ username: string; }”缺少类型“User”中的以下属性: gender, age, bio      

如何让它可行?使用 Partial 即可:

const user: Partial<User> = {
  username: 'awesomeuser'
}      

Partial 内置内型的作用就是让一个已定义了的类型的所有属性变得可选,具体实现如下:

/**
 * Make all properties in T optional
 */
type Partial<T> = {
    [P in keyof T]?: T[P];
};      

如何让一个类型的属性全部必填?

假设我们有下面这样一个类型定义:

type User = {
  username: string;
  age?: number;
  gender?: 'male' | 'female'
  bio?: string;
  password?: string;
}      

然后从服务器后端拿到了一系列用户数据的结果:

const users: User[] = await api.users.list();      

此时我们尝试去访问用户的 age 进行比较,想要取出 age > 18 的用户:

const filteredUsers = users.filter(user => user.age > 18);      

此时你的 IDE 是不是提示你:对象可能为“未定义”。?为什么?因为我们定义了 age 本身就是可选的属性,未定义该属性时,它的值就是 undefined,而在 typescript 中, undefined 是不允许与 number 类型进行比较的。

但是此时其实我们是能很确定 api.users.list 接口返回给我的,要么是抛出错误,要么给到我的就一定是带了 age 值的 User 类型数据,所以,我是完全可以去比较的,但是由于 TypeScript 并不知道你加载的数据是 User 还是所有属性都已经有值的特殊的 User,那怎么办?什么 Required 即可。

const users: Required<User>[] = [];      

或者让 api.users.list() 的返回类型就是 Required<User>[] 即可。

如何自己实现 Required:

/**
 * Make all properties in T required
 */
type Required<T> = {
    [P in keyof T]-?: T[P];
};      

如何让一个类型的所有属性变成只读?

假设我们现在在写一个系统,当用户登录之后,会共享一个 User 对象给所有组件,但是只允许他人读取其值,不允许他人修改,但是我们定义的 User 是整个系统共用的,有编辑功能的页面也在使用这个类型定义,它们是需要能修改用户数据的,那怎么办?

使用 Readonly 即可:

const user = {
  username: "awesomeuser",
  gender: "male",
  age: 19,
  bio: "Aha, insight~",
};


const sharedUser = user as Readonly<User>;


sharedUser.username = "new Name";      

此时,IDE 就会告诉你无法分配到 "username" ,因为它是只读属性。

注意:TypeScript 只作静态类型校验,但是并不表示这些值真的不能被修改了,如果真的要创建一个真正从程序上都不能被修改的对象,请问怎么解决?

我想有一个类,只具有另一个类的部分属性定义

还是那个 User,我想定义一个 Login 类型,它专门用于登录时的类型,但是我又不想重新去写一遍 username 与 password 的类型定义(虽然在本例中,重新写一遍也很简单,但保不齐哪天就会遇到一个十分复杂的类型定义呢?),怎么办?使用 Pick 即可。

type User = {
  username: string;
  gender?: "male" | "female";
  age?: number;
  bio?: string;
  password?: string;
};


type Login = Pick<User, "username" | "password">;


const login: Login = {
  username: "pantao",
};      

你们也看到了,Login 类型还是只有 username 是必填的,password 是可选的,这与我们的要求不符,怎么办?加上 Required 啊。

type User = {
  username: string;
  gender?: "male" | "female";
  age?: number;
  bio?: string;
  password?: string;
};


type Login = Required<Pick<User, "username" | "password">>;


const login: Login = {
  username: "pantao",
};      

此时就会要求你必须输入 password 了。

如何自己实现 Pick?

/**
 * From T, pick a set of properties whose keys are in the union K
 */
type Pick<T, K extends keyof T> = {
    [P in K]: T[P];
};      

如果快速定义一个类型中,具有相同数据类型的属性?

假设我们现在在开发一个商城系统,每一个 Store 都有一个店长,一个仓库管理员,一个收银员,他们都关联到了 User 上面,此时你可以这样定义 Store 这个类型:

type User = {
  username: string;
  gender?: "male" | "female";
  age?: number;
  bio?: string;
  password?: string;
};


type Store = {
  name: string;
  location: string;
  leader: User;
  warehouseKeeper: User;
  cashier: User;
};      

当然,你还可以这样定义:

type Store = Record<'leader' | 'warehouseKeeper' | 'cashier', User> & {
  name: string;
  location: string;
}      

两种方式,哪种更好,当然各有优劣,但是假设我们遇到下面这样的一个情况:

type User = {
  username: string;
  gender?: "male" | "female";
  age?: number;
  bio?: string;
  password?: string;
};


const users: User = [
  {
    username: "awesomeuser",
  },
  {
    username: "baduser",
  },
  {
    username: "gooduser",
  },
];      

为了访问方便,我想将 users 变量转换成一个属性名称为 users 数组索引,值为 users 数组元素(即 User 类型)的对象,怎么定义这样的一个类型?

你可以这样:

type UserSet = { [key: number]: User };


const userSet: UserSet = users.reduce(
  (set, user, index) => ({ ...set, [index]: user }),
  {} as UserSet
);      

你也可以这样:

type UserSet = Record<number, User>;      

如何自己实现 Record?

/**
 * Construct a type with a set of properties K of type T
 */
type Record<K extends keyof any, T> = {
    [P in K]: T;
};      

本文完~

学习更多技能

请点击下方公众号