TypeScript 文字联合类型与字符串枚举

在 TypeScript 中,有几种方法可以枚举类型的可能值。让我们考虑一个情况,我们的网站必须支持不同的主题,包括 defaultlightdark

它们可以通过以下方法之一定义:

  • 使用文字字符串类型的并集
type Theme = 'DEFAULT' | 'LIGHT' | 'DARK'
  • 使用枚举
enum Theme {
  DEFAULT,
  LIGHT,
  DARK
}

区别

TypeScript 不会为文字字符串类型的并集生成代码。因此,生成的代码将具有较小的大小。

以下是 TypeScript 编译 Theme 枚举时生成的代码:

var Theme
(function (Theme) {
  Theme[(Theme['DEFAULT'] = 0)] = 'DEFAULT'
  Theme[(Theme['LIGHT'] = 1)] = 'LIGHT'
  Theme[(Theme['DARK'] = 2)] = 'DARK'
})(Theme || (Theme = {}))

在使用联合类型的情况下,创建新变量时仍必须键入完整字符串,例如:

type Theme = 'DEFAULT' | 'LIGHT' | 'DARK'
const theme: Theme = 'DEFAULT'

像 VS Code 这样的流行编辑器可以帮助我们快速地从可能的值列表中选择值,但是如果我们想将值重构为其他值,我们必须在所有位置手动更改该值。

另一方面,当您重构代码或开发库时,使用 enum 会带来一些显著的好处。让我们来看一个简单的用例,您的库提供以下功能来将网站切换到给定的主题:

const switchTheme = (theme: Theme) => {
  // ...
}

export { Theme, switchTheme }

用户现在可以将特定主题传递给 switchTheme 函数,而无需考虑其背后的真正值:

import { Theme, switchTheme } from 'your-lib'

switchTheme(Theme.DARK)

switchTheme('DARK') 相比,上面的调用是多么方便和安全。

很高兴知道

自 TypeScript 3.4 起,我们可以使用 const 断言。

const Theme = {
  DEFAULT: 'Default',
  LIGHT: 'Light',
  DARK: 'Dark'
} as const

type Theme = typeof Theme[keyof typeof Theme]

let darkTheme: Theme = Theme.DARK
let lightTheme: Theme = 'Light'
const invalidTheme: Theme = 'Blue' // type error

建议

如果未设置枚举的值,则默认情况下,这些值将设置为递增数。

因此,Theme.DEFAULTTheme.LIGHTTheme.DARK 的值分别为 0、1 和 2。调试更加困难:

console.log(Theme.DARK) // 2

即使我们为枚举值设置了数字,我们仍然可以为类型为枚举的变量设置无效值:

enum Theme {
  DEFAULT = 0,
  LIGHT = 1,
  DARK = 2
}

// TypeScript 不会抛出错误
const theme: Theme.DEFAULT = 3

由于这些原因,建议对枚举值使用字符串文字。Theme 枚举应如下所示:

enum Theme {
  DEFAULT = 'Default',
  LIGHT = 'Light',
  DARK = 'Dark'
}

console.log(Theme.DARK) // 'Dark'

// 不能将类型 Default 分配给类型 Theme.DEFAULT
let theme: Theme.DEFAULT = 'Default' // type error

更多资料

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容