阅读 2435

Typescript 中的 Partial, Readonly, Record, Pick

在 typescript (后面简称为 ts)中定义 interface(后面简称为“接口”) 时,常常需要对进行二次封装或调整,而 ts 在2.1版本中加入了一些程序类型工具,供开发者方便的进行此类操作。

备注:这些程序类型仅限制用于 type 类型声明中。

可以先看看它们的源码定义:

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

/**
 * Make all properties in T readonly
 */
type Readonly<T> = {
    readonly [P in keyof T]: T[P];
};

/**
 * 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];
};

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

这些程序类型早在2016年就发布了,因此已经被很多框架或插件所使用。那么来依次说明:

Record

以 typeof 格式快速创建一个类型,此类型包含一组指定的属性且都是必填。

type Coord = Record<'x' | 'y', number>;

// 等同于
type Coord = {
	x: number;
	y: number;
}
复制代码

具体的复杂业务场景中,一般会接口 PickPartial 等组合使用,从而过滤和重组出新的类型定义。

Partial

将类型定义的所有属性都修改为可选。

type Coord = Partial<Record<'x' | 'y', number>>;

// 等同于
type Coord = {
	x?: number;
	y?: number;
}
复制代码

Readonly

不管是从字面意思,还是定义上都很好理解:将所有属性定义为自读。

type Coord = Readonly<Record<'x' | 'y', number>>;

// 等同于
type Coord = {
    readonly x: number;
    readonly x: number;
}

// 如果进行了修改,则会报错:
const c: Coord = { x: 1, y: 1 };
c.x = 2; // Error: Cannot assign to 'x' because it is a read-only property.
复制代码

Pick

从类型定义的属性中,选取指定一组属性,返回一个新的类型定义。

type Coord = Record<'x' | 'y', number>;
type CoordX = Pick<Coord, 'x'>;

// 等用于
type CoordX = {
	x: number;
}
复制代码

官方预置的高级类型还有很多其他的,已经补上了:TypeScript 的所有 高级类型