定义 TypeScript 对象键的类型:使用 Record 和 Partial

定义 TypeScript 对象键的类型:使用 Record 和 Partial

本文介绍了如何使用 typescript 的 Record 和 Partial 工具类型来精确定义对象键的类型。通过使用 Record,可以强制对象的键必须是预定义的字符串字面量类型,从而确保类型安全。而 Partial 则允许对象只包含部分预定义的键,提供了更灵活的类型定义方式。

使用 Record 定义对象键类型

在 TypeScript 中,我们经常需要定义对象的键必须是特定类型。例如,我们可能希望创建一个对象,其键只能是预定义的字符串字面量类型,例如 “tl”、”us-dollar” 和 “euro”。 TypeScript 提供了 Record 工具类型,可以完美地解决这个问题。

Record 的定义如下:

type Record<K extends String | number | symbol, T> = { [P in K]: T }

其中,K 表示键的类型,必须是 string、number 或 symbol 的联合类型;T 表示值的类型。

以下是一个使用 Record 的示例:

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

在这个例子中,我们定义了一个 Currencies 类型,它是字符串字面量类型的联合。然后,我们使用 Record 来定义 currenciesMap 对象的类型。这意味着 currenciesMap 对象的键必须是 Currencies 类型中的一个值,而值必须是 string 类型。

注意: 当使用 Record 来声明变量时,TypeScript 会强制要求对象包含所有可能的键。如果缺少任何一个键,TypeScript 编译器会报错。

使用 Partial 允许部分键

有时,我们可能不需要对象包含所有预定义的键,而只需要包含其中的一部分。在这种情况下,我们可以使用 Partial 工具类型。

Partial 的定义如下:

type Partial<T> = { [P in keyof T]?: T[P] | undefined };

Partial 会将 T 中所有属性设置为可选属性。

以下是一个使用 Partial 的示例:

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

在这个例子中,我们使用 Partial> 来定义 currenciesMap 对象的类型。这意味着 currenciesMap 对象的键可以是 Currencies 类型中的一个值,也可以不包含任何键。

总结

Record 和 Partial 是 TypeScript 中非常有用的工具类型,可以帮助我们精确地定义对象键的类型,提高代码的可读性和可维护性。

  • 使用 Record 可以强制对象包含所有预定义的键。
  • 使用 Partial 可以允许对象只包含部分预定义的键。

通过合理使用这两个工具类型,可以编写出更加健壮和类型安全的 TypeScript 代码。

© 版权声明
THE END
喜欢就支持一下吧
点赞9 分享