TypeScript 枚举


作者:Seiya

时间:2019年08月01日


枚举


enum 类型是对 JavaScript 标准数据类型的一个补充。 像C#等其它语言一样,使用枚举类型可以为一组数值赋予友好的名字。枚举类型用于取值被限定在一定范围内的场景,比如一周只能有七天,颜色限定为红绿蓝等。

enum Days {Sun, Mon, Tue, Wed, Thu, Fri, Sat};
console.log(Days["Sun"] === 0); // true
console.log(Days[0] === "Sun"); // true

事实上,上面的例子会被编译为:

var Days;
(function (Days) {
	Days[Days["Sun"] = 0] = "Sun";
	Days[Days["Mon"] = 1] = "Mon";
	Days[Days["Tue"] = 2] = "Tue";
	Days[Days["Wed"] = 3] = "Wed";
	Days[Days["Thu"] = 4] = "Thu";
	Days[Days["Fri"] = 5] = "Fri";
	Days[Days["Sat"] = 6] = "Sat";
})(Days || (Days = {}));



手动赋值


enum Days {Sun = 7, Mon = 1, Tue, Wed, Thu, Fri, Sat};

console.log(Days["Sun"] === 7); // true
console.log(Days["Mon"] === 1); // true
console.log(Days["Tue"] === 2); // true
console.log(Days["Sat"] === 6); // true

如果未手动赋值的枚举项与手动赋值的重复了,TypeScript 是不会察觉到这一点的:

enum Days {Sun = 3, Mon = 1, Tue, Wed, Thu, Fri, Sat};

console.log(Days["Sun"] === 3); // true
console.log(Days["Wed"] === 3); // true
console.log(Days[3] === "Sun"); // false
console.log(Days[3] === "Wed"); // true

上面的例子中,递增到 3 的时候与前面的 Sun 的取值重复了,但是 TypeScript 并没有报错,导致 Days[3] 的值先是 "Sun",而后又被 "Wed" 覆盖了。编译的结果是:

var Days;
(function (Days) {
	Days[Days["Sun"] = 3] = "Sun";
	Days[Days["Mon"] = 1] = "Mon";
	Days[Days["Tue"] = 2] = "Tue";
	Days[Days["Wed"] = 3] = "Wed";
	Days[Days["Thu"] = 4] = "Thu";
	Days[Days["Fri"] = 5] = "Fri";
	Days[Days["Sat"] = 6] = "Sat";
})(Days || (Days = {}));

手动赋值的枚举项可以不是数字,此时需要使用类型断言来让 tsc 无视类型检查 (编译出的 js 仍然是可用的):

enum Days {Sun = 7, Mon, Tue, Wed, Thu, Fri, Sat = <any>"S"};

当然,手动赋值的枚举项也可以为小数或负数,此时后续未手动赋值的项的递增步长仍为 1:

enum Days {Sun = 7, Mon = 1.5, Tue, Wed, Thu, Fri, Sat};

console.log(Days["Sun"] === 7); // true
console.log(Days["Mon"] === 1.5); // true
console.log(Days["Tue"] === 2.5); // true



常数项和计算所得项


枚举项有两种类型:常数项(constant member)和计算所得项(computed member)。


前面我们所举的例子都是常数项,一个典型的计算所得项的例子:

enum Color {Red, Green, Blue = "blue".length};

"blue".length 就是一个计算所得项。


上面的例子不会报错,但是如果紧接在计算所得项后面的是未手动赋值的项,那么它就会因为无法获得初始值而报错:

enum Color {Red = "red".length, Green, Blue};		// error



常数枚举


常数枚举是使用 const enum 定义的枚举类型:

const enum Directions {
	Up,
	Down,
	Left,
	Right
}

注意:

常数枚举与普通枚举的区别是,它会在编译阶段被删除,并且不能包含计算成员。




外部枚举


外部枚举(Ambient Enums)是使用 declare enum 定义的枚举类型:

declare enum Directions {
	Up,
	Down,
	Left,
	Right
}

注意:

declare 定义的类型只会用于编译时的检查,编译结果中会被删除。

外部枚举与声明语句一样,常出现在声明文件中。

最后更新时间: 2019-8-2 10:12:24