使用 TypeScript Record 类型定义对象键

本文介绍了如何使用 typescript 的 Record 实用类型来精确定义对象的键，使其只能是预定义的字符串字面量类型。通过示例代码，详细讲解了 Record 的用法，以及如何结合 Partial 类型来实现可选属性。

使用 Record 类型约束对象键

在 TypeScript 中，我们经常需要定义对象的键的类型。当对象的键是预先定义的字符串字面量类型时，Record 类型就派上了用场。Record 类型接受两个泛型参数：K 表示键的类型，必须是 String、number 或 symbol 的联合类型；T 表示值的类型。

Record 类型本质上定义了一个对象，其键是 K 类型的所有可能值，对应的值的类型是 T。

例如，我们定义一个 Currencies 类型，表示货币类型：

type Currencies = "tl" | "us-dollar" | "euro";

现在，我们想要创建一个对象 currenciesMap，它的键必须是 Currencies 类型中的一个，值是字符串类型。我们可以使用 Record 类型来实现：

type Currencies = "tl" | "us-dollar" | "euro";  const currenciesMap: Record = {   tl: "₺",   "us-dollar": "$",   euro: "€", };

这样，currenciesMap 对象的键就只能是 “tl”、”us-dollar” 或 “euro” 中的一个，值必须是字符串类型。如果尝试使用其他键，TypeScript 编译器会报错。

Record 类型与 Partial 类型结合使用

使用 Record 类型声明变量时，会强制声明所有可能的属性。如果某些属性是可选的，我们可以结合 Partial 类型来实现。Partial 类型将类型 T 的所有属性都变为可选属性。

例如，如果 currenciesMap 对象中的某些货币类型的值可以为空，我们可以这样定义：

type Currencies = "tl" | "us-dollar" | "euro";  const currenciesMap: Partial> = {   tl: "₺",   "us-dollar": "$", };

现在，currenciesMap 对象中可以只包含 “tl” 和 “us-dollar” 两个键，而不需要包含 “euro” 键。

总结

Record 类型是 TypeScript 中一个非常实用的工具类型，可以用来精确定义对象的键的类型。结合 Partial 类型，可以实现可选属性。合理使用 Record 类型，可以提高代码的可读性和可维护性，减少错误。

注意事项：

• Record 类型的第一个泛型参数 K 必须是 string、number 或 symbol 的联合类型。
• 使用 Record 类型声明变量时，会强制声明所有可能的属性，如果某些属性是可选的，可以使用 Partial 类型。