Typescript - 类型操作符&索引访问类型

Typescript提供一些非常有用的类型操作符,如keyof/typeof,在日常开发中灵活应用这些函数利于编写更为健壮的代码。

keyof 操作符

⚠️ keyof只能作用于类型。

keyof后面跟的是对象类型,则其结果为该对象类型的属性组成的union类型。以下面的代码为例:

type Point = { x: number; y: number };
type P = keyof Point;
// P = 'x' | 'y';

上面代码中,P的实际类型为 'x' | 'y'

如果keyof后的类型包含字符串或数字的索引签名,则其返回索引本身的类型。

  • 示例1
type ArrayLike = { [k: number]: unknown };
type Key = keyof ArrayLike;

类型Key实际为number

  • 示例2
type MapLike = { [k: string]: unknown };
type Key = keyof MapLike;

类型Key实际为number | string

⚠️ 这里的Keynumberstring的联合类型,其原因是在javascript对象的key会被自动转为字符串类型。obj[0]等价于obj['0']

typeof 操作符

⚠️ typeof通常作用于标识符(identifier-变量的名字,可以是标识符自身或标识符的属性(变量对应的值是对象的场景下)。

例如 type M = typeof 'cluo',此时类型校验系统会报错。

typeof必需作用于identifier

正确的用法应该为

let name = 'cluo';
type M = typeof name;

M的类型为string

索引访问类型(Indexed Access Types)

类型是一类特殊的存在,虽然不能直接参与代码中的运算,但类型本身是可以通过一些运算生成其他类型。其中,通过索引获取相应的类型就是一类。
如下代码:

type Person = { age: number; name: string; alive: boolean };
type Age = Person["age"];

通过获取Personage属性,获取其类型并赋值给Age。这种获取类型的方法就是通过索引获取相应的类型。非常类似于对象的属性值获取。但与对象属性获取不同的是,类型索引本身也是类型
这句话不是那么容易理解,可以通过下面的代码及其对应的截图来对比:

  • 使用值获取属性类型
使用值作为索引类型
  • 使用类型获取属性类型


    使用类型作为索引

相应的代码:

type age = 'age';
type Person = { age: number; name: string; alive: boolean };
type AgeType = Person[age];

单个字符串的书写可能会让读者困惑,那么使用字符串联合类型的写法更为清晰。如下所示:

type Person = { age: number; name: string; alive: boolean };
type AgeAndName = Person['age' | 'name'];

可以看到索引为 'age' | 'name',这是一个字符串联合类型。
相应的,既然索引是类型,那通过类型操作符获得的类型也可以作为索引,继续改造上述的代码,获取Person所有的属性类型联合,则相应的代码如下:

type Person = { age: number; name: string; alive: boolean };
type AllPropType = Person[keyof Person];

此时AllPropType'number' | 'string' | 'boolean',也就是将所有属性的类型取出来联合运算。

应用

上面介绍了3种获取类型的方法,它们在实际开发中有着相当强大的作用。比如例举下面的几种场景,看看如何使用上面的类型操作符化腐朽为神奇。

  • 已知const RGB = ['red', 'green', 'blue'],如何将变量类型限制为RGB数组中的项?
  • 已知const RGB = { R: 'red', G: 'green', B: 'blue', };,如何将变量类型限制RGB对象的属性值域?

其实上面2个场景的问题是类似的,根据已有的标识符获取目标类型,很容易想到使用typeof类型操作符。

一,数组场景

目标类型:'red' | 'green' | 'blue'

  1. RGB执行typeof
const RGB = ['red', 'green', 'blue'];
type T = typeof RGB[number];

类型Tstring,这显然与预期的类型是不一致的。目标类型为字符串常量的联合,而typeof如果要生成常量类型那么操作符后面的也必须是常量,否则只能获取变量的类型。举个🌰:

let r = 'red';
type TypeOfR = typeof r;

let定义的变量做typeof得到的是类型string,如图:

变量类型获取

但如果使用const定义,其他不变,得到的类型就是常量'red',如图:

常量类型获取

  1. RGB的项常量化
const RGB = ['red', 'green', 'blue'] as const;
type T = typeof RGB[number];

通过上面的修改,T的类型就变成'red' | 'green' | 'blue',跟预期一致。

二,对象场景

对象场景和数组场景解决方案一样,只是在获取索引类型时稍有区别,具体可以参看前文的索引类型章节,相应的代码如下:

const RGB = {
  R: 'red',
  G: 'green',
  B: 'blue',
} as const;
type TypeOfRGB = typeof RGB;
type KeyOfRGB = keyof TypeOfRGB;
export type T = TypeOfRGB[KeyOfRGB];

对象场景下,搭配keyof类型操作符用以获取属性的联合类型,本质上依然是获取索引类型。

小结:

本文介绍typescript的3种类型获取的方法,包括类型操作符keyof/typeof索引类型获取,并通过两个实际的案例介绍如何灵活使用这几种方案获取相应的类型。

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

推荐阅读更多精彩内容