TypeScript 映射枚举

Question

在我的应用程序中，我们混合使用模拟和真实 REST 数据。在 TypeScript 中，为了方便起见，我定义了一大堆枚举。

当我使用数据创建任何类型的模拟数组时，我使用以下限制：

enum MyEnum { 'myEnumValue1' = 0, myEnumValue2 } 
(...)
 enumField: MyEnum.myEnumValue1,
(...)

TypeScript 有效地将其解析为数字：

(...)
enumField: 1,
(...)

但是，在我的 REST API 中，我收到了与其字符串表示形式相同的一组枚举。两种方式都可以通过以下方式进行转换：

MyEnum['string'] => number
MyEnum[number] => string

MyEnum['myEnumValue1'] => 0
MyEnum[0] => 'myEnumValue1'

是否可以生成以优雅方式处理此转换的通用类，类似于 Stack 社区在 THIS question 中建议我的方式

Answer 1

您可以创建一个类似于对象的函数：

// Return type is a bit more tricky because we have to get the enum type from typeof enum
function fromValue<T>(o: T, value: string): { [P in keyof T]: T[P]  }[keyof T]{
    return  (o as any)[value]; // No type safety here unfrotunately
}

var value = fromValue(MyEnum, ""); //value will be of type MyEnum

Answer 2

除了来自 Titan 的完美答案之外，这里还有一个小调整，可以针对您希望映射的值类型（字符串或数字）和您希望的统一结果（字符串或数字）以两种方式工作：

enum MyEnum {
    'VAL_ONE' = 0,
    'VAL_TWO' = 1
}

function fromValuetoNumber<T>(o: T, value: string | number): {[P in keyof T]: T[P]} {
    if (typeof (value) === 'string') {
        return  (o as T)[value]; 
    } else if (typeof (value) === 'number') {
        return (o as T)[o[value]]
    }   
}

function fromValueToString<T>(o: T, value: string | number): {[P in keyof T]: T[P]} {
    if (typeof (value) === 'string') {
        return  (o as T)[o[value]]; 
    } else if (typeof (value) === 'number') {
        return (o as T)[value]
    }   
}

console.log(fromValuetoNumber(MyEnum, 'VAL_ONE'))
console.log(fromValuetoNumber(MyEnum, 0))

console.log(fromValueToString(MyEnum, 'VAL_ONE'))
console.log(fromValueToString(MyEnum, 0))

唯一仍然困扰我的是事实，如果要分配泛型类型，TypeScript 就会发疯：

fromValueToString<MyEnum>(MyEnum, 'VAL_ONE')

不过，这只是对原始答案的补充。

Answer 3

用string literals 代替枚举怎么样？

我猜您正在使用 enums 来避免拼写错误，并且您希望 TypeScript 为您“捕捉”它。因此，如果您使用string literals，您是类型安全，您将使用相同的“语言”与服务器交谈

例如：

export type Sex = 'male' | 'female';
var sex: Sex = 'mela'; // Typo => ERROR from typescript

Answer 4

使用ts-enum-util（github，npm），您可以通过运行时验证在枚举值和名称之间（在任一方向）执行类型安全的转换。如果在运行时遇到无效值，您可以选择抛出错误或返回默认值（默认未定义）的方法变体。

例子：

import {$enum} from "ts-enum-util";

enum MyEnum {
    FOO = 0,
    BAR = 1
}

function getMyEnum1(apiString: string): MyEnum {
    // throws informative error if "apiString" is not 
    // "FOO" or "BAR"
    return $enum(MyEnum).getValueOrThrow(apiString);
}

function getMyEnum2(apiString: string): MyEnum {
    // returns MyEnum.FOO if "apiString" is not 
    // "FOO" or "BAR"
    return $enum(MyEnum).getValueOrDefault(apiString, MyEnum.FOO);
}

function getMyEnum3(apiString: string): MyEnum | undefined {
    // returns undefined if "apiString" is not 
    // "FOO" or "BAR"
    return $enum(MyEnum).getValueOrDefault(apiString);
}

// type: ("FOO" | "BAR")
// value: "BAR"
const enumName = $enum(MyEnum).getKeyOrThrow(1);