TypeScript如何模拟原生enum特性禁止直接传入对应字符串字面量
实现思路
原生enum能禁止同值字面量传入,本质是它属于TS中为数不多的名义类型,和默认的结构类型判断逻辑不同:哪怕普通字符串和枚举成员值完全一致,类型也不兼容。我们可以通过给字符串值增加仅类型层面的唯一标签,模拟出名义类型的效果,就可以实现你要的限制。
完整实现代码
enum Colors { red = '$r5', green = '$g2', lightBlue = '$b9', darkBlue = '$b1', } // 私有唯一标记,不对外导出,外部无法自行构造符合类型的值 const EnumNominalTag = Symbol('EnumNominalTag'); // 带标签的枚举值类型,和普通字符串天然不兼容 type EnumValue<T extends string> = T & { [EnumNominalTag]: true }; function createKeyEnum<E extends Record<string, unknown>>(originEnum: E): {[K in keyof E]: EnumValue<K & string>} { return Object.keys(originEnum).reduce((result, key) => { // 运行时值还是普通字符串,标签仅存在于类型层面,无运行时开销 (result as any)[key] = key as EnumValue<typeof key>; return result; }, {} as ReturnType<typeof createKeyEnum<E>>); } const NewColors = createKeyEnum(Colors); // 类型直接取NewColors对象的所有值的联合,不是key的联合 type NewColors = typeof NewColors[keyof typeof NewColors]; // 正向映射 function getOldColor(color: NewColors) { return Colors[color as unknown as keyof typeof Colors]; } // 反向映射 function getNewColor(color: Colors): NewColors { const reverseMap: Record<string, string> = {}; Object.entries(Colors).forEach(([k, v]) => reverseMap[v] = k); return reverseMap[color] as unknown as NewColors; } // 测试效果 getOldColor(NewColors.darkBlue); // 正常通过 getOldColor('darkBlue'); // 类型报错,符合预期 const color = getNewColor(Colors.darkBlue); // typeof color 严格等于 NewColors 类型,符合需求
补充说明
- 运行时枚举值还是原生字符串,没有额外属性,不会影响性能、序列化等逻辑,标签仅在TS类型校验阶段生效
- 因为标记用的Symbol不对外导出,外部永远无法自己构造出符合
EnumValue类型的值,只能从createKeyEnum生成的对象上获取属性,和原生enum的使用限制完全一致
内容的提问来源于stack exchange,提问作者iceblueorbitz
相关产品推荐
相关产品推荐

