TypeScript 检查值是否在枚举中

在 TypeScript 中，我们可以使用枚举来表示一组相关的常量。当我们需要检查一个值是否在特定的枚举中时，可以使用 keyof typeof 和类型断言。

枚举

枚举是一种特殊的类型，它定义了一组常量。下面是一个简单的枚举示例：

enum Color {
  Red,
  Green,
  Blue,
}

在这个枚举中，Color 定义了三个常量：Red、Green 和 Blue。这三个常量的值分别是 0、1 和 2。如果没有为枚举成员指定值，则默认从 0 开始从左到右依次递增。

我们可以使用枚举来替代硬编码的常量，提高代码可读性和可维护性。

检查值是否在枚举中

有时候我们需要检查一个值是否在特定的枚举中。可以使用 keyof typeof 和类型断言来实现。下面是一个示例：

enum Color {
  Red,
  Green,
  Blue,
}

function isColor(color: string): color is keyof typeof Color {
  return color in Color;
}

console.log(isColor("Red"));    // true
console.log(isColor("Yellow")); // false

在这个示例中，我们定义了一个函数 isColor，它接收一个字符串类型的参数 color，并使用 in 操作符检查该参数是否在枚举 Color 中。如果在枚举中，返回 true，否则返回 false。

keyof typeof Color 用于获取枚举的键，即 Red、Green 和 Blue，类型为 'Red' | 'Green' | 'Blue'。类型断言 color is keyof typeof Color 用于告诉 TypeScript，如果 color 在枚举中，它是枚举的键类型，否则它是 any 类型。

在这个示例中，我们使用了类型守卫 color is keyof typeof Color，当 isColor 返回 true 时，可以确保 color 的类型是枚举的键类型，可以在后续代码中安全地使用。

总结

在 TypeScript 中，可以使用枚举来定义常量集合。使用 keyof typeof 和类型断言可以检查一个值是否在特定的枚举中，并确保类型安全。这种方式提高了代码的可读性和可维护性。