网站搜索

Typescript:如何检查一个值是否是有效的枚举键值?


在 TypeScript 中,有没有办法获取枚举的名称,比如 nameof(FirstEnum)?下面的代码有一个丑陋的 if switch,每次定义新枚举时都必须扩展。有没有更通用的方法在 TypeScript 中实现同样的功能?

enum FirstEnum {
    First = 0,
    Second = 1,
    Third = 2,
}
enum SecondEnum {
    One,
    Two,
}


function translateEnum(type$, val): string {
    let lookupKey = '';
    if (type$ === FirstEnum) {
        lookupKey = `firstenum.${FirstEnum[val]}`;
    } else if (type$ === SecondEnum) {
        lookupKey = `secondenum.${SecondEnum[val]}`;
    } else {
        throw new Error('not supported');
    }
    //lookupkey example: secondenum.One
    const result = ''; //translate here, ex. await translationService.translate(lookupkey);
    return result;
}

translateEnum(SecondEnum , SecondEnum.One);

答案#1

由于 TypeScript 的 Enums 被转换为 JavaScript 对象,你可以使用 in 操作符检查 enum 的键值是否属于 enums。请注意,这仅适用于非 const 且基于数字的 enums。

enum FirstEnum {
    First = 0,
    Second = 1,
    Third = 2,
}
enum SecondEnum {
    One,
    Two,
}


function translateEnum(val: FirstEnum | SecondEnum): string {
    let lookupKey = '';
    if (val in FirstEnum || val in SecondEnum) {
      console.log(`Enum value ${val} is valid!`);
      //lookupkey example: secondenum.One
      const result = ''; //translate here, ex. await translationService.translate(lookupkey);
      return result;
    } else {
        console.log(`Enum value ${val} not supported.`);
        throw new Error('not supported');
    }
}

translateEnum(SecondEnum.One);

translateEnum(10);

输出

Enum value 0 is valid!
Enum value 10 not supported.
Uncaught Error: not supported
    at translateEnum (eval at <anonymous> (main-0.js:804), <anonymous>:23:15)
    at eval (eval at <anonymous> (main-0.js:804), <anonymous>:27:1)
    at main-0.js:804

更多信息

查看 stackoverflow 问题 在 TypeScript 中检查值是否存在于枚举中。