用于将字符串枚举成员转换为枚举的Typescript函数

Question

我想用Typescript写这样的东西：

export function stringToEnum<T>(enumObj: T, str: string): keyof T {
    return enumObj[str];
}

并按如下方式使用：

enum MyEnum {
  Foo
}

stringToEnum<MyEnum>(MyEnum, 'Foo');

它会返回的地方

我的E num. Foo

上面的函数按预期工作…但是输入抛出错误。对于stringToEnum中的参数MyEnum

类型'typeof MyEnum'的参数不能分配给类型'MyEnum'的参数

这是有道理的...不幸。关于如何解决这个问题的任何想法？




Answer 1

 stringToEnum(MyEnum, 'Foo');

只需保留泛型并让打字脚本来完成。这是因为存储在MyEnum下的类型与Enum本身不匹配，而是其值的联合类型：

 enum Test { A, B };

 const value: Test /* "A" | "B" */ = Test.A;

Answer 2

你的签名有点混乱。如果希望方法返回枚举值，则返回类型应为T[keyofT]。strparam的类型也应该是键的T，以防止传入无效字符串，但这将限制您传入字符串文本（或类型为 的类型良好的变量，而不是＜code＞字符串＜/code＞）：

function stringToEnum<T>(enumObj: T, str: keyof T): T[keyof T]

那么要么不指定类型参数，让编译器正确推断类型:

// type: Foo
// value: 0  
const result = stringToEnum(MyEnum, 'Foo');

或者你需要提供 MyEnum 的类型作为类型参数：

// type: Foo
// value: 0  
const result = stringToEnum<typeof MyEnum>(MyEnum, 'Foo');

如果您真的希望能够传入任何任意字符串枚举名称，那么返回类型是谎言：应该是T[key of T]|未定义的。如果str的类型是string并且您启用了no的任何编译器选项，则在尝试enumObj[str]时也会遇到麻烦。

要使泛型函数正确使用枚举类型，尤其是在运行时具有反向查找项的数值枚举，还有更多的工作要做。查看tsenum-util（github，npm）的源代码以获得灵感

Answer 3

您可以在本地完成所有操作，而无需编写函数：

enum Color {
    red,
    green,
    blue
}

// Enum to string
const redString: string = Color[Color.red];
alert(redString);

// String to enum
const str = 'red';
const redEnum: Color = Color[str];
alert(redEnum);

或者你可以玩得开心点…

enum MyEnum {
  Foo,
  Bar
}

function stringToEnum<ET, T>(enumObj: ET, str: keyof ET): T{
    return enumObj[<string>str];
}

const val = stringToEnum<typeof MyEnum, MyEnum>(MyEnum, 'Foo');

// Detects that `foo` is a typo
const val2 = stringToEnum<typeof MyEnum, MyEnum>(MyEnum, 'foo');