在 TypeScript 中查找字符串枚举值的准确类型

Question

假设我有这个字符串枚举：

enum Color {
    None = "Q",
    Red = "R",
    Green = "G",
    Blue = "B",
}

现在，在 TypeScript 中，string enums have no reverse mappings，所以我不能写Color["Q"] 来获得潜在的Color。我尝试声明自己的辅助函数：

type StringEnum = {[key: string]: string};
function lookup<E extends StringEnum>(stringEnum: E, s: string): keyof E | undefined {
    for (const enumValue of keysOf(stringEnum)) {
        if (stringEnum[enumValue] === s) {
            return enumValue;
        }
    }
    return undefined;
}

keysOf 存在

function keysOf<K extends {}>(o: K): (keyof K)[];
function keysOf(o: any) { return Object.keys(o); }

...但实际上，我不知道返回类型应该是什么。这是为了编译，但不是：

const color: Color = lookup(Color, "Q") || Color.None;

因为lookup 函数的返回类型现在是"None" | "Red" | "Green" | "Blue" | undefined 而不仅仅是Color | undefined。

能在保留类型信息的同时很好的解决这个问题吗？

Answer 1

您的lookup 函数返回一个枚举字符串key，但您也提供枚举值 Color.None 作为短路，以防lookup 返回未定义。所以这里的类型不匹配。

一般来说，字符串枚举键可以像this这样输入：

type ColorKeys = keyof typeof Color // "None" | "Red" | "Green" | "Blue"
const blueKey: keyof typeof Color = "Blue" 

如果你写const blueValue = Color.None，变量blueValue 保存的是枚举字符串值"Q"，而不是文字"None"。所以我们可以通过以下方式修复const color的赋值：

const color = lookup(Color, "Q") || "None";
// or with explicit type
const color: keyof typeof Color = lookup(Color, "Q") || "None";

枚举类型cannot have an index signature，所以我在这里输入StringEnum 为{[key: string]: any} 以使其编译。

Playground

更新：从lookup 获取键入的枚举值

如果您想将一个未缩小的字符串值传递给lookup，并将其作为缩小的枚举值类型（如果存在）返回（否则为undefined），您可以按照与第一个示例类似的方式进行操作：

function lookup<E extends StringEnum>(
  stringEnum: E,
  s: string
): E[keyof E] | undefined {
  for (const enumKey of keysOf(stringEnum)) {
    if (stringEnum[enumKey] === s) {
      // here we have to help the compiler
      return stringEnum[enumKey] as E[keyof E];
    }
  }
  return undefined;
}

// let's test it
const look = lookup(Color, "Q") // const look: Color | undefined

// for further understanding
type AllColorKeys = keyof typeof Color // = "None" | "Red" | "Green" | "Blue"
type AllColorValues = (typeof Color)[keyof typeof Color] // = Color
type IsColorSuperType = Color.Blue extends Color ? true: false // = true

在Color枚举的情况下，返回的lookup type将返回值Q，类型为Color | undefined，作为所有可能的Color枚举值Color.None、Color.Red等的联合on 将是超类型Color。定义的枚举结构本身具有typeof Color 类型，与static and instance side of a class 相当。

Playground