Typescript:来自枚举的字符串文字联合类型

Question

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

对于这个枚举......

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

......我想得到这个:

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

我试过typeof keyof Weekday但结果却是'MONDAY' | 'TUESDAY' | 'WEDNESDAY'.感觉解决方案可能与映射类型有关,但我似乎无法绕过它.

我该怎么做呢？

Answer 1

打字稿 4.1+：

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

type WeekdayType = `${Weekday}`;

打字稿 3.4+：

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

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

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

编辑：

为那些想要深入挖掘的人写了一篇博文。

Answer 2

这不能编程方式...你想转换的类型Weekday,也就是Weekday.MONDAY | Weekday.TUESDAY | Weekday.WEDNESDAY,在类型WeekdayType是"mon" | "tue" | "wed".此转换是一种扩展形式,因为它Weekday是以下子类型WeekdayType:

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

不幸的是,编译器没有给你一个从枚举类型中删除"枚举"的句柄,并留下普通的文字类型.

那么,解决方法？也许你实际上并不需要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

因此,在此变通方法中,没有"枚举"性,因此无需区分类型Weekday和类型WeekdayType.它与实际enum(包括类似的类型Weekday.MONDAY,您必须表示为繁琐typeof Weekday.MONDAY或为其创建不同的类型别名)略有不同,但它可能表现得足够相似而且非常有用.那对你有用吗？

希望有所帮助.祝好运!

Answer 3

使用Typescript 4.1可以做到！

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

type WeekdayType = `${Weekday}`;

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