Typescript 枚举作为接口答案

【问题标题】：Typescript enums as interfacesTypescript 枚举作为接口
【发布时间】：2020-10-26 06:19:16
【问题描述】：

我正在使用一个用于 TS 生成的库 (ts-protoc-gen)，它为枚举生成以下内容：

export interface AnimalTypeMap {
    Dog: 0;
    Cat: 1;
    Fish: 2;
    Bird: 3;
}

export const AnimalType: AnimalTypeMap;

应该如何食用？

if (arg === AnimalType.Bird) {} // **ERROR**: Variable 'AnimalType' is used before being assigned
if (arg === AnimalTypeMap.Bird) {} // **ERROR**:'AnimalTypeMap' only refers to a type, but is being used as a value here

如何在不初始化的情况下导出 const？

【问题讨论】：

为什么不使用普通枚举？接口在运行时不存在，所以你不能做你在这里尝试的事情。
其他选项会将其导出为值：export const AnimalType = { Dog: 0, Cat: 1 } as const
相关：How do the different enum variants work in TypeScript?

标签： typescript enums interface protobuf.js

【解决方案1】：

在 typescript 中更改您的枚举类，如下所示

 export interface AnimalTypeMap 
     {
    Dog: Dog;
    Cat: Cat;
    Fish: Fish;
    Bird: Bird;
     }

在后端使用

 [JsonConverter(typeof(StringEnumConverter))]
    public enum AnimalTypeMap {
{
        Dog: 1;
        Cat: 2;
        Fish: 3;
        Bird: 4;
         }

如果你使用 c#

【讨论】：

界面是自动生成的，我无法控制
如果您使用相同的代码生成器或其他代码生成器，只需在您的枚举上添加 [JsonConverter(typeof(StringEnumConverter))] 即可
这是不可能的，类型是在 protobuff 文件中定义的。请假设我的第一个代码 sn-p 已给出且无法修改，您将如何在纯 TS 中使用它？
使用这个：if (arg === AnimalType['Bird']) {}

【解决方案2】：

如果您将 --ts-out 和 --js-out 都包含在 protoc 中，那么这对我有用：

import {AnimalType, AnimalTypeMap} from "./generated/AnimalType_pb"
const animalType:AnimalTypeMap[keyof AnimalTypeMap] = AnimalType.Bird;

但这并不完全直观，我认为这不是正确的做法。但至少它有效。

编辑：有一个 fork：https://github.com/gnomesley/ts-protoc-gen 生成正常的 TypeScript 枚举。它更直观。

【讨论】：