打字稿：来自枚举的字符串文字联合类型

Question

我想从一个枚举中得到一个字符串文字联合。

对于这个枚举…

enum Weekday {
    MONDAY = 'mon',
    TUESDAY = 'tue',
    WEDNESDAY = 'wed'
}

…我想要这个：

type WeekdayType = 'mon' | 'tue' | 'wed';

我尝试了typeof keyof Weekday，但结果是'MONDAY' | 'TUESDAY' | 'WEDNESDAY'。感觉解决方案可能与映射类型有关，但我似乎无法理解它。

我该怎么做？

Answer 1

见TS4.1 ANSWER:

type WeekdayType = `${Weekday}`;

---

TS-4.1 之前的答案：

这不能以编程方式完成...您正在尝试将类型 Weekday（即 Weekday.MONDAY | Weekday.TUESDAY | Weekday.WEDNESDAY）转换为类型 WeekdayType（即 "mon" | "tue" | "wed"）。这种转换是一种加宽的形式，因为Weekday是WeekdayType的子类型：

type WeekdayExtendsWeekdayType = 
  Weekday extends WeekdayType ? true : false
// type WeekdayExtendsWeekdayType = true

不幸的是，编译器没有给你一个句柄来从枚举类型中删除“枚举”-ness 并留下纯文字类型。

---

那么，解决方法？也许您实际上并不需要enum，但可以使用属性值为字符串文字的对象：

const lit = <V extends keyof any>(v: V) => v;
const Weekday = {
  MONDAY: lit("mon"),
  TUESDAY: lit("tue"),
  WEDNESDAY: lit("wed")
}
type Weekday = (typeof Weekday)[keyof typeof Weekday],

如果您检查它，名为 Weekday 的 值 的行为就像一个枚举对象：

console.log(Weekday.TUESDAY); // tue

而名为Weekday 的类型 的行为类似于您调用的"mon" | "tue" | "wed" 字符串值的联合WeekdayType：

const w: Weekday = "wed"; // okay
const x: Weekday = "xed"; // error

因此，在此解决方法中，没有“枚举”-ness，因此无需区分类型 Weekday 和类型 WeekdayType。它与实际的 enum 有点不同（其中包括 types，例如 Weekday.MONDAY，您必须将其表示为繁琐的 typeof Weekday.MONDAY 或为其创建不同的类型别名），但是它的行为可能足够相似以至于有用。这对你有用吗？

希望对您有所帮助。祝你好运！

Answer 2

TypeScript 4.1+：

As mentioned，这可以通过使用模板文字类型来实现，如下所示：

type WeekdayType = `${Weekday}`;

TypeScript 3.4+：

跟进@jcalz 的回答和@just-boris 的评论，这里有一个带有 const 断言的示例：

const Weekday = {
  MONDAY: "mon",
  TUESDAY: "tue",
  WEDNESDAY: "wed",
} as const;

type Weekday = (typeof Weekday)[keyof typeof Weekday];

编辑：

为想要深入挖掘的人写了blog post。

Answer 3

有了Typescript 4.1，就可以搞定！

enum Weekday {
  MONDAY = 'mon',
  TUESDAY = 'tue',
  WEDNESDAY = 'wed'
}

type WeekdayType = `${Weekday}`;

警告：这仅适用于字符串枚举值，不适用于数字枚举值。