如何在TypeScript中创建枚举类型?

时间:2012-10-02 09:29:48

标签: enums typescript

我正在为TypeScript的Google maps API制作定义文件。

我需要定义类似枚举的例如。 google.maps.Animation包含两个属性:BOUNCEDROP

如何在TypeScript中完成?

6 个答案:

答案 0 :(得分:124)

TypeScript 0.9+具有枚举规范:

enum AnimationType {
    BOUNCE,
    DROP,
}

最后一个逗号是可选的。

答案 1 :(得分:63)

从TypeScript 0.9(目前是alpha版本)开始,你可以像这样使用枚举定义:

enum TShirtSize {
  Small,
  Medium,
  Large
}

var mySize = TShirtSize.Large;

默认情况下,这些枚举将分别分配0,1和2。如果要显式设置这些数字,可以将其作为枚举声明的一部分。

清单6.2具有显式成员的枚举

enum TShirtSize {
  Small = 3,
  Medium = 5,
  Large = 8
}

var mySize = TShirtSize.Large;

这两个例子都直接取自TypeScript for JavaScript Programmers

请注意,这与0.8规范不同。 0.8规范看起来像这样 - 但它被标记为实验性且可能会更改,因此您必须更新任何旧代码:< / p>

免责声明 - 这个0.8示例将在较新版本的TypeScript编译器中被破坏。

enum TShirtSize {
  Small: 3,
  Medium: 5,
  Large: 8
}

var mySize = TShirtSize.Large;

答案 2 :(得分:22)

现在这是该语言的一部分。有关此文档,请参阅TypeScriptLang.org > Basic Types > enum。关于如何使用这些枚举的文档的摘录:

enum Color {Red, Green, Blue};
var c: Color = Color.Green;

或者手动支持号码:

enum Color {Red = 1, Green = 2, Blue = 4};
var c: Color = Color.Green;

您还可以使用例如Color[2]返回枚举名称。

以下是这一切如何结合在一起的一个例子:

module myModule {
    export enum Color {Red, Green, Blue};

    export class MyClass {
        myColor: Color;

        constructor() {
            console.log(this.myColor);
            this.myColor = Color.Blue;
            console.log(this.myColor);
            console.log(Color[this.myColor]);
        }
    }
}

var foo = new myModule.MyClass();

这将记录:

undefined  
2  
Blue

因为在撰写本文时,Typescript Playground将生成以下代码:

var myModule;
(function (myModule) {
    (function (Color) {
        Color[Color["Red"] = 0] = "Red";
        Color[Color["Green"] = 1] = "Green";
        Color[Color["Blue"] = 2] = "Blue";
    })(myModule.Color || (myModule.Color = {}));
    var Color = myModule.Color;
    ;
    var MyClass = (function () {
        function MyClass() {
            console.log(this.myColor);
            this.myColor = Color.Blue;
            console.log(this.myColor);
            console.log(Color[this.myColor]);
        }
        return MyClass;
    })();
    myModule.MyClass = MyClass;
})(myModule || (myModule = {}));
var foo = new myModule.MyClass();

答案 3 :(得分:14)

另外请注意,您可以使用以下内容进行id / string枚举:

class EnumyObjects{
    public static BOUNCE={str:"Bounce",id:1};
    public static DROP={str:"Drop",id:2};
    public static FALL={str:"Fall",id:3};


}

答案 4 :(得分:8)

<强>更新

如@ iX3所述, Typescript 2.4 支持枚举字符串。

请参阅:Create an enum with string values in Typescript

原始回答:

对于String成员值,TypeScript仅允许数字作为枚举成员值。但是你可以实现一些解决方案/黑客;

解决方案1:

复制自:https://blog.rsuter.com/how-to-implement-an-enum-with-string-values-in-typescript/

有一个简单的解决方案:在分配之前,只需将字符串文字强制转换为:

export enum Language {
    English = <any>"English",
    German = <any>"German",
    French = <any>"French",
    Italian = <any>"Italian"
}

解决方案2:

复制自:https://basarat.gitbooks.io/typescript/content/docs/types/literal-types.html

您可以使用字符串文字作为类型。例如:

let foo: 'Hello';

这里我们创建了一个名为foo的变量,它只允许为其分配文字值“Hello”。这在下面说明:

let foo: 'Hello';
foo = 'Bar'; // Error: "Bar" is not assignable to type "Hello"

它们本身并不是很有用,但可以组合在一个类型联合中来创建一个强大的(有用的)抽象,例如:

type CardinalDirection =
    "North"
    | "East"
    | "South"
    | "West";

function move(distance: number, direction: CardinalDirection) {
    // ...
}

move(1,"North"); // Okay
move(1,"Nurth"); // Error!

答案 5 :(得分:1)

打字稿中的枚举:

枚举被放入打字稿语言中,以定义一组命名常量。使用枚举可以使我们的生活更轻松。原因是这些常量通常比枚举表示的值更易于阅读。

创建枚举:

enum Direction {
    Up = 1,
    Down,
    Left,
    Right,
}

这个来自打字稿文档的例子很好地解释了枚举的工作方式。请注意,我们的第一个枚举值(Up)初始化为1。随后,该枚举的所有以下成员从该值自动递增(即Down = 2,Left = 3,Right = 4) 。如果我们不使用1初始化第一个值,则枚举将从0开始,然后自动递增(即Down = 1,Left = 2,Right = 3)。

使用枚举:

我们可以通过以下方式访问枚举的值:

Direction.Up;     // first the enum name, then the dot operator followed by the enum value
Direction.Down;

请注意,通过这种方式,我们在编写代码时更加描述性。枚举基本上阻止了我们使用魔术数字(代表某些实体的数字,因为程序员在特定上下文中为其赋予了含义)。幻数不好是由于以下原因:

  1. 我们需要加倍思考,首先需要将数字转换为实体,然后才能推理代码。
  2. 如果我们过了很长时间才查看我们的代码,或者其他程序员查看了我们的代码,他们不一定知道这些数字的含义。