Ts-枚举

定义声明

枚举类型适合-描述一组映射常量值

声明枚举 使用 enum 关键字

访问枚举成员 Color.Key=== 0 , 反响映射 Color[0] === 'Key'

enum Color {
  Red,Blue,Green
}

枚举成员会被赋值为从 0 开始递增的数字，同时也会对枚举值到枚举名进行反向映射

所有成员的类型都是枚举变量的子类型

enum Days {Sun, Mon, Tue, Wed, Thu, Fri, Sat};
//枚举成员会被赋值为从 0 开始递增的数字，同时也会对枚举值到枚举名进行反向映射：
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 = {}));

数字枚举

成员值为数字，类型为数字字面量

未使用初始化生成器（手动赋值），枚举成员 从0 开始，后面的成员 +1递增

    enum Day {
        SUNDAY, //=0
        MONDAY, //=1
        TUSEDAY,
        WEDNESDAY,
        THURSDAY,
        FRIDAY,
        SATURDAY
    }

手动赋值后，后面的成员值+1递增

//成员值递增
enum Day1 {
    SUNDAY = 4,
    MONDAY = 7,
    TUESDAY, //=8
    WEDNESDAY = 10,
    THURSDAY, //=11
    FRIDAY,
    SATURDAY
}

如果定义了成员是小数或者负数，后面的成员依然+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
console.log(Days["Sat"] === 6.5); // true

手动赋值的成员可能会与后面递增的成员值相等，Ts 不会报错，后者会覆盖前者

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 = {}));

两个数字枚举结构一样，仍然不是恒等，所有的枚举类型都只兼容自身

enum Day {
    SUNDAY,
    ...
}

enum MyDay {
    SUNDAY,
    ...
}
Day.SUNDAY === MyDay.SUNDAY; // ts(2367) 两个枚举值恒不相等

work(MyDay.SUNDAY); // ts(2345) 'MyDay.SUNDAY' 不能赋予 'Day'
function work(d: Day) {
    switch (d) {
        case Day.SUNDAY:
        case Day.SATURDAY:
            return 'take a rest';
        case Day.MONDAY:
        case Day.TUESDAY:
        case Day.WEDNESDAY:
        case Day.THURSDAY:
        case Day.FRIDAY:
            return 'work hard';
    }
}

//枚举类型  商品订单状态
enum OrderStatue {
        all,
        unpay,
        unsend,
        sended,
        complete
    }

    function showOrderStatus(status: OrderStatue) {
        switch (status) {
            case OrderStatue.all:
                console.log('all')
                break;
            case OrderStatue.unpay:
                console.log('unpay')
                break;
            case OrderStatue.unsend:
                console.log('unsend')
                break;
            case OrderStatue.sended:
                console.log('sended')
                break;
            case OrderStatue.complete:
                console.log('complete')
                break;
            default:
                console.log('default')
                break;
        }
    }

    showOrderStatus(OrderStatue.all)
    showOrderStatus(1)
    showOrderStatus(14)

字符串枚举

成员必须是字符串字面量

enum Direction {
    Up = "UP",
    Down = "DOWN",
    Left = "LEFT",
    Right = "RIGHT",
}

如果前面成员手动赋值，后面的成员没有赋值会报错，字符串枚举不能再+1递增

enum Color {
    reg ,
    green='green',
    blue //TS1061: Enum member must have initializer.
}
//blue 无法+1 递增 没有初始值就报错提示 

异构枚举

数字和字符串混合的枚举类型，很少用到

enum BooleanLikeHeterogeneousEnum {
    No = 0,
    Yes = "YES",
}

常量成员和计算值成员

枚举成员的值分两种行为获得，常量成员 和计算值所得成员

enum Color {Red, Green, Blue = "blue".length};
//计算值所得成员

下面是常数项和计算所得项的完整定义

当满足以下条件时，枚举成员被当作是常数：

• 不具有初始化函数并且之前的枚举成员是常数。在这种情况下，当前枚举成员的值为上一个枚举成员的值加 1。但第一个枚举元素是个例外。如果它没有初始化方法，那么它的初始值为 0。
• 枚举成员使用常数枚举表达式初始化。常数枚举表达式是 TypeScript 表达式的子集，它可以在编译阶段求值。当一个表达式满足下面条件之一时，它就是一个常数枚举表达式：

• • 数字字面量
  • 引用之前定义的常数枚举成员（可以是在不同的枚举类型中定义的）如果这个成员是在同一个枚举类型中定义的，可以使用非限定名来引用
  • 带括号的常数枚举表达式
  • +, -, ~ 一元运算符应用于常数枚举表达式
  • +, -, *, /, %, <<, >>, >>>, &, |, ^ 二元运算符，常数枚举表达式做为其一个操作对象。若常数枚举表达式求值后为 NaN 或 Infinity，则会在编译阶段报错

所有其它情况的枚举成员被当作是需要计算得出的值。

常数枚举

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

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

let directions = [Directions.Up, Directions.Down, Directions.Left, Directions.Right];

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

上例的编译结果是：

var directions = [0 /* Up */, 1 /* Down */, 2 /* Left */, 3 /* Right */];

假如包含了计算成员，则会在编译阶段报错：

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

// index.ts(1,38): error TS2474: In 'const' enum declarations member initializer
//must be constant expression.

外部枚举

外部枚举（Ambient Enums）是使用 declare enum 定义的枚举类型：

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

let directions = [Directions.Up, Directions.Down, Directions.Left, Directions.Right];

之前提到过，declare 定义的类型只会用于编译时的检查，编译结果中会被删除。

上例的编译结果是：

var directions = [Directions.Up, Directions.Down, Directions.Left, Directions.Right];

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

同时使用 declare 和 const 也是可以的：

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

let directions = [Directions.Up, Directions.Down, Directions.Left, Directions.Right];

编译结果：

var directions = [0 /* Up */, 1 /* Down */, 2 /* Left */, 3 /* Right */];