typescript 中的 record 工具类型

Record 工具类型背景

在 TypeScript 中，Record 是一个工具类型，用于构造具有特定键和值类型的对象。它提供了一种简洁的方法来定义对象的结构，当你需要一个限定键和值类型的对象时非常有用。

Record 类型语法

Record<Keys, Type>

  • Keys: 键的联合类型。
  • Type: 所有属性值的类型。

使用示例

1
2
3
4
5
6
7
8
type UserRoles = 'admin' | 'user' | 'guest';
type UserPermissions = Record<UserRoles, boolean>;

const permissions: UserPermissions = {
  admin: true,
  user: false,
  guest: false,
};

参数说明

  • UserRoles: 字符串字面量联合类型，定义了允许的键。
  • UserPermissions: Record 类型，将每个 UserRoles 键映射到一个布尔值。

注意点

  • Record 的键必须是字符串、数字或符号（symbol）。
  • 所有指定的键必须被赋予相应的值，否则会导致编译错误。

Record 与其他工具类型对比

工具类型 功能描述
Record 构建具有特定键和值类型的对象
Partial 将所有属性设为可选
Readonly 将所有属性设为只读
Pick 从对象中选择一组属性组成新类型
Omit 从对象中排除一组属性组成新类型

产生原因

在复杂应用中，经常需要对某些数据结构进行约束，而手动编写这些约束可能繁琐且易出错。Record 提供了一种简洁且可重用的方法来实现这一目的，确保代码更易于维护和理解。