来自 JSON 字符串的打字稿`enum`

Question

有没有办法让 TypeScript 枚举与来自 JSON 的字符串兼容？

例如：

enum Type { NEW, OLD }

interface Thing { type: Type }

let thing:Thing = JSON.parse('{"type": "NEW"}');

alert(thing.type == Type.NEW); // false

我想thing.type == Type.NEW是真实的。 或者更具体地说，我希望我可以将enum值指定为字符串，而不是数字。

我知道我可以使用thing.type.toString() == Type[Type.NEW]但这很麻烦并且似乎使枚举类型注释混淆和误导，这违背了它的目的。 JSON 在技术上没有提供有效的枚举值，所以我不应该在枚举中键入属性。

所以我目前正在做的是使用带有静态常量的字符串类型：

const Type = { NEW: "NEW", OLD: "OLD" }

interface Thing { type: string }

let thing:Thing = JSON.parse('{"type": "NEW"}');

alert(thing.type == Type.NEW); // true

这让我得到了我想要的用法，但是类型注释string太宽泛且容易出错。

我有点惊讶 JavaScript 的超集没有基于字符串的枚举。 我错过了什么吗？ 有没有不同的方法可以做到这一点？

---

更新 TS 1.8

使用字符串文字类型是另一种选择（感谢@basaret），但要获得所需的类似枚举的用法（上文），它需要两次定义您的值：一次在字符串文字类型中，一次作为值（常量或命名空间）：

type Type = "NEW" | "OLD";
const Type = {
    NEW: "NEW" as Type,
    OLD: "OLD" as Type
}

interface Thing { type: Type }

let thing:Thing = JSON.parse(`{"type": "NEW"}`);

alert(thing.type === Type.NEW); // true

这有效，但需要大量样板文件，足以让我大部分时间不使用它。 现在我希望string enums的提议最终会成为路线图。

---

更新 TS 2.1

新的keyof类型查找允许从 const 或命名空间的键生成字符串文字类型，这使得定义不那么冗余：

namespace Type {
    export const OLD = "OLD";
    export const NEW = "NEW";
}
type Type = keyof typeof Type;

interface Thing { type: Type }

const thing: Thing = JSON.parse('{"type": "NEW"}');
thing.type == Type.NEW // true

---

更新 TS 2.4

TypeScript 2.4 添加了对字符串枚举的支持！ 上面的例子变成：

enum Type {
    OLD = "OLD",
    NEW = "NEW"
}

interface Thing { type: Type }
const thing: Thing = JSON.parse('{"type": "NEW"}');
alert(thing.type == Type.NEW) // true

这看起来几乎完美，但仍有一些心痛：

• 你仍然必须写两次值，即OLD = "OLD" ，并且没有验证你没有错字，比如NEW = "MEW" ......这已经在真正的代码中咬我了。

• 枚举的类型检查方式有一些奇怪（也许是错误？），它不仅仅是字符串文字类型的速记，这才是真正正确的。 我遇到的一些问题：

   enum Color { RED = "RED", BLUE = "BLUE", GREEN = "GREEN" } type ColorMap = { [P in Color]: number; } declare const color: Color; declare const map: ColorMap; map[color] // Error: Element implicitly has an 'any' type because type 'ColorMap' has no index signature. const red: Color = "RED"; // Type '"RED"' is not assignable to type 'Color'. const blue: Color = "BLUE" as "RED" | "BLUE" | "GREEN"; // Error: Type '"RED" | "BLUE" | "GREEN"' is not assignable to type 'Color'.

  用字符串文字类型替换enum Color的等效代码工作正常......

是的，我想我对此有强迫症，我只想要我完美的 JS 枚举。 :)

Answer 1

如果您在 2.4 版本之前使用 Typescript，则可以通过将 enum 的值转换为any来使用 enum 实现这一点。

第一个实现的示例

enum Type {
    NEW = <any>"NEW",
    OLD = <any>"OLD",
}

interface Thing { type: Type }

let thing:Thing = JSON.parse('{"type": "NEW"}');

alert(thing.type == Type.NEW); // true

Typescript 2.4 已经内置了对字符串枚举的支持，因此不再需要转换为any并且您可以在不使用String Literal Union Type情况下实现它，这对于验证和自动完成来说是可以的，但对于可读性和重构，取决于使用场景。

Answer 2

TS 2.9.2
我的解决方案：

export enum Enums { VALUE1, VALUE2 }

当我从 API json 中获得价值时：

 switch (response.enumValue.toString()) { //can be without toString if we have string value from JSON.
    case Enums[Enums.VALUE1]:
      ...
    case Enums[Enums.VALUE2]:
      ...
 }

Answer 3

如果有人在 2021 年仍在关注这个问题：

@Aaron 在原始问题中写道：

这看起来几乎完美，但仍有一些心痛：

你仍然必须[...]

 enum Color { RED = "RED", BLUE = "BLUE", GREEN = "GREEN" } type ColorMap = { [P in Color]: number; } declare const color: Color; declare const map: ColorMap; map[color] // Error: Element implicitly has an 'any' type because type 'ColorMap' has no index signature. // [...]

用字符串文字类型替换枚举颜色的等效代码工作正常......

是的，我想我对此有强迫症，我只想要我完美的 JS 枚举。 :)

keyof typeof enumObj

关于，

用字符串文字类型替换枚举颜色的等效代码工作正常......

在链式连接中使用typeof和keyof运算符。

type ColorKeys = keyof typeof Color
type ColorMap = { [P in ColorKeys]: number; } // will have strongly typed keys

访问map: ColorMap时不再隐含any 。
这也适用于数字枚举（可以（并且通常应该）是const ）。

来自Typescript Handbook - Enums at compile time ：

即使枚举是在运行时存在的真实对象，keyof 关键字的工作方式与您对典型对象的预期不同。 相反，使用 keyof typeof 获取将所有 Enum 键表示为字符串的 Type。

2. ts-enum-util

查看ts-enum-util ，它为（可能）所有与枚举相关的需求提供强类型接口。

Answer 4

我一直在使用转换器功能作为权宜之计。 希望这个线程得到解决： https : //github.com/Microsoft/TypeScript/issues/1206

enum ErrorCode {
    Foo,
    Bar
}

interface Error {
    code: ErrorCode;
    message?: string;
}

function convertToError(obj: any): Error {
    let typed: Error = obj as Error;

    // Fix any enums
    typed.code = ErrorCode[typed.code.toString()];
    return typed;
}

Answer 5

但是类型注释字符串太宽泛且容易出错。

同意。 一种快速解决方法（如果您有足够的代码生成能力，您可以自动执行此操作）：

interface Thing { type: "NEW" | "OLD" }

这些在union中称为字符串文字。 更多： https : //basarat.gitbooks.io/typescript/content/docs/tips/stringEnums.html