Enums

Enums

Enums allow us to define a set of named constants.Using enums can make it easier to document intent, or create a set of distinct cases.TypeScript provides both numeric and string-based enums.

Numeric enums

We’ll first start off with numeric enums, which are probably more familiar if you’re coming from other languages.An enum can be defined using the enum keyword.

  1. enum Direction {
  2.     Up = 1,
  3.     Down,
  4.     Left,
  5.     Right,
  6. }

Above, we have a numeric enum where Up is initialized with 1.All of the following members are auto-incremented from that point on.In other words, Direction.Up has the value 1, Down has 2, Left has 3, and Right has 4.

If we wanted, we could leave off the initializers entirely:

  1. enum Direction {
  2.     Up,
  3.     Down,
  4.     Left,
  5.     Right,
  6. }

Here, Up would have the value 0, Down would have 1, etc.This auto-incrementing behavior is useful for cases where we might not care about the member values themselves, but do care that each value is distinct from other values in the same enum.

Using an enum is simple: just access any member as a property off of the enum itself, and declare types using the name of the enum:

  1. enum Response {
  2.     No = 0,
  3.     Yes = 1,
  4. }
  6. function respond(recipient: string, message: Response): void {
  7.     // ...
  8. }
  10. respond("Princess Caroline", Response.Yes)

Numeric enums can be mixed in computed and constant members (see below).The short story is, enums without initializers either need to be first, or have to come after numeric enums initialized with numeric constants or other constant enum members.In other words, the following isn’t allowed:

  1. enum E {
  2.     A = getSomeValue(),
  3.     B, // Error! Enum member must have initializer.
  4. }

String enums

String enums are a similar concept, but have some subtle runtime differences as documented below.In a string enum, each member has to be constant-initialized with a string literal, or with another string enum member.

  1. enum Direction {
  2.     Up = "UP",
  3.     Down = "DOWN",
  4.     Left = "LEFT",
  5.     Right = "RIGHT",
  6. }

While string enums don’t have auto-incrementing behavior, string enums have the benefit that they “serialize” well.In other words, if you were debugging and had to read the runtime value of a numeric enum, the value is often opaque - it doesn’t convey any useful meaning on its own (though reverse mapping can often help), string enums allow you to give a meaningful and readable value when your code runs, independent of the name of the enum member itself.

Heterogeneous enums

Technically enums can be mixed with string and numeric members, but it’s not clear why you would ever want to do so:

  1. enum BooleanLikeHeterogeneousEnum {
  2.     No = 0,
  3.     Yes = "YES",
  4. }

Unless you’re really trying to take advantage of JavaScript’s runtime behavior in a clever way, it’s advised that you don’t do this.

Computed and constant members

Each enum member has a value associated with it which can be either constant or computed.An enum member is considered constant if:

  • It is the first member in the enum and it has no initializer, in which case it’s assigned the value 0:
  1. // E.X is constant:
  2. enum E { X }
  • It does not have an initializer and the preceding enum member was a numeric constant.In this case the value of the current enum member will be the value of the preceding enum member plus one.
  1. // All enum members in 'E1' and 'E2' are constant.
  3. enum E1 { X, Y, Z }
  5. enum E2 {
  6.     A = 1, B, C
  7. }

  • The enum member is initialized with a constant enum expression.A constant enum expression is a subset of TypeScript expressions that can be fully evaluated at compile time.An expression is a constant enum expression if it is:

    • a literal enum expression (basically a string literal or a numeric literal)
    • a reference to previously defined constant enum member (which can originate from a different enum)
    • a parenthesized constant enum expression
    • one of the +, -, ~ unary operators applied to constant enum expression
    • +, -, *, /, %, <<, >>, >>>, &, |, ^ binary operators with constant enum expressions as operandsIt is a compile time error for constant enum expressions to be evaluated to NaN or Infinity.

In all other cases enum member is considered computed.

  1. enum FileAccess {
  2.     // constant members
  3.     None,
  4.     Read    = 1 << 1,
  5.     Write   = 1 << 2,
  6.     ReadWrite  = Read | Write,
  7.     // computed member
  8.     G = "123".length
  9. }

Union enums and enum member types

There is a special subset of constant enum members that aren’t calculated: literal enum members.A literal enum member is a constant enum member with no initialized value, or with values that are initialized to

  • any string literal (e.g. "foo", "bar, "baz")
  • any numeric literal (e.g. 1, 100)
  • a unary minus applied to any numeric literal (e.g. -1, -100)When all members in an enum have literal enum values, some special semantics come to play.

The first is that enum members also become types as well!For example, we can say that certain members can only have the value of an enum member:

  1. enum ShapeKind {
  2.     Circle,
  3.     Square,
  4. }
  6. interface Circle {
  7.     kind: ShapeKind.Circle;
  8.     radius: number;
  9. }
  11. interface Square {
  12.     kind: ShapeKind.Square;
  13.     sideLength: number;
  14. }
  16. let c: Circle = {
  17.     kind: ShapeKind.Square, // Error! Type 'ShapeKind.Square' is not assignable to type 'ShapeKind.Circle'.
  18.     radius: 100,
  19. }

The other change is that enum types themselves effectively become a union of each enum member.While we haven’t discussed union types yet, all that you need to know is that with union enums, the type system is able to leverage the fact that it knows the exact set of values that exist in the enum itself.Because of that, TypeScript can catch silly bugs where we might be comparing values incorrectly.For example:

  1. enum E {
  2.     Foo,
  3.     Bar,
  4. }
  6. function f(x: E) {
  7.     if (x !== E.Foo || x !== E.Bar) {
  8.         //             ~~~~~~~~~~~
  9.         // Error! This condition will always return 'true' since the types 'E.Foo' and 'E.Bar' have no overlap.
  10.     }
  11. }

In that example, we first checked whether x was not E.Foo.If that check succeeds, then our || will short-circuit, and the body of the ‘if’ will run.However, if the check didn’t succeed, then x can only be E.Foo, so it doesn’t make sense to see whether it’s equal to E.Bar.

Enums at runtime

Enums are real objects that exist at runtime.For example, the following enum

  1. enum E {
  2.     X, Y, Z
  3. }

can actually be passed around to functions

  1. function f(obj: { X: number }) {
  2.     return obj.X;
  3. }
  5. // Works, since 'E' has a property named 'X' which is a number.
  6. f(E);

Enums at compile time

Even though Enums are real objects that exist at runtime, the keyof keyword works differently than you might expect for typical objects. Instead, use keyof typeof to get a Type that represents all Enum keys as strings.

  1. enum LogLevel {
  2.     ERROR, WARN, INFO, DEBUG
  3. }
  5. /**
  6.  * This is equivalent to:
  7.  * type LogLevelStrings = 'ERROR' | 'WARN' | 'INFO' | 'DEBUG';
  8.  */
  9. type LogLevelStrings = keyof typeof LogLevel;
  11. function printImportant(key: LogLevelStrings, message: string) {
  12.     const num = LogLevel[key];
  13.     if (num <= LogLevel.WARN) {
  14.        console.log('Log level key is: ', key);
  15.        console.log('Log level value is: ', num);
  16.        console.log('Log level message is: ', message);
  17.     }
  18. }
  19. printImportant('ERROR', 'This is a message');

Reverse mappings

In addition to creating an object with property names for members, numeric enums members also get a reverse mapping from enum values to enum names.For example, in this example:

  1. enum Enum {
  2.     A
  3. }
  4. let a = Enum.A;
  5. let nameOfA = Enum[a]; // "A"

TypeScript might compile this down to something like the the following JavaScript:

  1. var Enum;
  2. (function (Enum) {
  3.     Enum[Enum["A"] = 0] = "A";
  4. })(Enum || (Enum = {}));
  5. var a = Enum.A;
  6. var nameOfA = Enum[a]; // "A"

In this generated code, an enum is compiled into an object that stores both forward (name -> value) and reverse (value -> name) mappings.References to other enum members are always emitted as property accesses and never inlined.

Keep in mind that string enum members do not get a reverse mapping generated at all.

const enums

In most cases, enums are a perfectly valid solution.However sometimes requirements are tighter.To avoid paying the cost of extra generated code and additional indirection when accessing enum values, it’s possible to use const enums.Const enums are defined using the const modifier on our enums:

  1. const enum Enum {
  2.     A = 1,
  3.     B = A * 2
  4. }

Const enums can only use constant enum expressions and unlike regular enums they are completely removed during compilation.Const enum members are inlined at use sites.This is possible since const enums cannot have computed members.

  1. const enum Directions {
  2.     Up,
  3.     Down,
  4.     Left,
  5.     Right
  6. }
  8. let directions = [Directions.Up, Directions.Down, Directions.Left, Directions.Right]

in generated code will become

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

Ambient enums

Ambient enums are used to describe the shape of already existing enum types.

  1. declare enum Enum {
  2.     A = 1,
  3.     B,
  4.     C = 2
  5. }

One important difference between ambient and non-ambient enums is that, in regular enums, members that don’t have an initializer will be considered constant if its preceding enum member is considered constant.In contrast, an ambient (and non-const) enum member that does not have initializer is always considered computed.