通用枚举类型守卫

23 浏览
0 Comments

通用枚举类型守卫

我可以编写一个非通用的类型保护来检查一个给定的字符串是否是一个字符串枚举的成员，像这样：\n

enum MyEnum {
  Thing1 = 'thing one',
  Thing2 = 'thing two',
}
const isMyEnum = (token: any): token is MyEnum => {
  return Object.values(MyEnum).includes(token as MyEnum);
};

\n是否可能使它成为通用的，以便我可以在许多不同的字符串枚举中重用相同的检查逻辑？

0

3 答案

0 Comments

问题的出现原因：

问题出现在isEnumValue函数的实现上。该函数的目的是判断一个值是否为枚举类型中的一个有效值。但是由于函数中的类型约束，导致该函数只能用于字符串类型的枚举，无法用于其他类型的枚举。

解决方法：

为了解决这个问题，可以修改isEnumValue函数的类型约束，使其适用于所有类型的枚举。具体的修改如下：

const isEnumValue = <T>(something: any, enumObject: T): something is T[keyof T] =>
    typeof something === 'string' && Object.values(enumObject).includes(something);

通过将类型约束修改为，可以使isEnumValue函数适用于所有类型的枚举。

修改后的函数可以正常使用于不同类型的枚举。例如：

enum StringEnum {
    A = 'aaa',
    B = 'bbb',
}
enum NumberEnum {
    A,
    B,
}
let a;
if (isEnumValue(a, StringEnum)) {
    if (a === 'SOMETHING') {
        // 编译器不会报错
    }
}
if (isEnumValue(a, NumberEnum)) {
    // 编译器不会报错
}

0
0 Comments

在TypeScript中，字符串枚举和数字枚举在生成的JavaScript代码上有着明显的区别。对于字符串枚举而言，可以通过一种通用的类型保护方法来判断某个值是否属于该枚举。然而，对于数字枚举，可能会误以为同样的方法也适用于数字枚举，这是需要注意的。

以下是一个示例代码，展示了如何使用通用的枚举类型保护方法来判断某个值是否属于一个枚举类型：

enum E {
  A,
  B,
  C,
}
const isSomeEnum = (e: T): (token: any) => token is T[keyof T] => 
  (Object as any).values(e).includes(token as T[keyof T]);
console.log(isSomeEnum(E)("A")); // 期望输出：false，实际输出：true
console.log(isSomeEnum(E)(0));   // 期望输出：true，实际输出：true

上述代码中，`isSomeEnum`函数接收一个枚举类型作为参数，并返回一个函数，用于判断传入的值是否属于该枚举类型。然而，在对数字枚举使用该方法时，会产生错误的结果。

为了解决这个问题，可以使用下面的代码示例中的`isSomeEnum2`函数来替代`isSomeEnum`函数：

function isSomeEnum2(e: T): (token: unknown) => token is T[keyof T] {
  const keys = Object.keys(e)
    .filter((k) => {
      return !/^\d/.test(k);
    });
  const values = keys.map((k) => {
    return (e as any)[k];
  });
  return (token: unknown): token is T[keyof T] => {
    return values.includes(token);
  };
};
console.log(isSomeEnum2(E)("A")); // 期望输出：false，实际输出：false
console.log(isSomeEnum2(E)(0));   // 期望输出：true，实际输出：true

`isSomeEnum2`函数使用了正则表达式来过滤掉数字开头的枚举键，并生成了一个包含枚举值的数组。然后，返回一个函数，用于判断传入的值是否属于该枚举类型。通过使用这种方法，可以正确地判断数字枚举的值是否属于该枚举类型。

，字符串枚举和数字枚举在使用通用的枚举类型保护方法时需要注意其差异。对于数字枚举，需要使用额外的步骤来正确判断其值是否属于该枚举类型。

0
0 Comments

泛型枚举类型保护（Generic enum type guard）是一种解决 TypeScript 中枚举类型保护问题的方法。下面的代码展示了一个实现泛型枚举类型保护的函数isSomeEnum：

const isSomeEnum = <T>(e: T) => (token: any): token is T[keyof T] =>
    Object.values(e).includes(token as T[keyof T]);

这个函数可以从枚举对象中生成类型保护函数。其中的T[keyof T]表示枚举对象的属性值的类型。

通过调用isSomeEnum(MyEnum)，可以将类型T推断为typeof MyEnum，然后T[keyof T]就是这个枚举对象的属性值类型MyEnum。

如果想要避免使用any类型并安全地为T指定类型，可以对isSomeEnum函数进行改进：

const isSomeEnum = <T extends { [s: string]: unknown }>(e: T) => (token: unknown): token is T[keyof T] => Object.values(e).includes(token as T[keyof T]);

这样，isSomeEnum函数就能够安全地为T指定类型了。

这种构造函数的方式在一定程度上是必要的，因为有时候需要将其转换为单个函数的形式。但是反过来并不总是可行的。

以上是关于泛型枚举类型保护的原因和解决方法的整理。通过使用这种方法，我们可以更好地处理 TypeScript 中的枚举类型保护问题，提高代码的类型安全性。

0