ts枚举
枚举
枚举(Enum)类型用于取值被限定在一定范围内的场景,比如一周只能有七天,颜色限定为红绿蓝等。
枚举使用 enum 关键字来定义:
1 | enum Days {Sun, Mon, Tue, Wed, Thu, Fri, Sat}; |
枚举成员会被赋值为从 0 开始递增的数字,同时也会对枚举值到枚举名进行反向映射:
1 | enum Days {Sun, Mon, Tue, Wed, Thu, Fri, Sat}; |
上面的例子会被编译为:
1 | var Days; |
手动赋值
我们也可以给枚举项手动赋值:
1 | enum Days {Sun = 7, Mon = 1, Tue, Wed, Thu, Fri, Sat}; |
未手动赋值的枚举项会接着上一个枚举项递增。
如果未手动赋值的枚举项与手动赋值的重复了,TypeScript 是不会察觉到这一点的:
1 | enum Days {Sun = 3, Mon = 1, Tue, Wed, Thu, Fri, Sat}; |
上面的例子中,递增到 3 的时候与前面的 Sun 的取值重复了,但是 TypeScript 并没有报错,导致 Days[3] 的值先是 "Sun",而后又被 "Wed" 覆盖了。编译的结果是:
1 | var Days; |
所以使用的时候需要注意,最好不要出现这种覆盖的情况。
手动赋值的枚举项可以不是数字,此时需要使用类型断言来让 tsc 无视类型检查 (编译出的 js 仍然是可用的):
1 | enum Days {Sun = 7, Mon, Tue, Wed, Thu, Fri, Sat = <any>"S"}; |
当然,手动赋值的枚举项也可以为小数或负数,此时后续未手动赋值的项的递增步长仍为 1:
1 | enum Days {Sun = 7, Mon = 1.5, Tue, Wed, Thu, Fri, Sat}; |
常数枚举
常数枚举是使用 const enum 定义的枚举类型:
1 | const enum Directions { |
常数枚举与普通枚举的区别是,它会在编译阶段被删除,并且不能包含计算成员。
上例的编译结果是:
1 | var directions = [0 /* Up */, 1 /* Down */, 2 /* Left */, 3 /* Right */]; |
假如包含了计算成员,则会在编译阶段报错:
1 | const enum Color {Red, Green, Blue = "blue".length}; |
外部枚举
外部枚举(Ambient Enums)是使用 declare enum 定义的枚举类型:
1 | declare enum Directions { |
declare 定义的类型只会用于编译时的检查,编译结果中会被删除。
上例的编译结果是:
1 | var directions = [Directions.Up, Directions.Down, Directions.Left, Directions.Right]; |
外部枚举与声明语句一样,常出现在声明文件中。
同时使用 declare 和 const 也是可以的:
1 | declare const enum Directions { |
编译结果:
1 | var directions = [0 /* Up */, 1 /* Down */, 2 /* Left */, 3 /* Right */]; |
参考:
- 本文标题:ts枚举
- 本文作者:灵感胜于汗水
- 创建时间:2022-11-06 21:49:09
- 本文链接:https://cjhsyc.github.io/2022/11/06/ts枚举/
- 版权声明:本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!