【TypeScript】 `const enum` について #TypeScript

はじめに

const enumは、TypeScriptで提供される最適化された列挙型です。通常のenumとは異なり、const enumはコンパイル時にインライン展開され、より効率的なコードを生成します。

`const enum`の基本的な使い方

const enumは通常のenumと同じように定義できます。ただし、constキーワードを追加します。

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

let direction: Direction = Direction.Up;
console.log(direction); // 0

このコードは、コンパイル時に以下のように変換されます。

let direction = 0 /* Direction.Up */;
console.log(direction); // 0

このように、const enumのメンバーはコンパイル時にインライン展開され、実行時に追加のオブジェクト参照を避けることができます。

利点

1. 高速な実行時パフォーマンス

const enumは、コンパイル時にインライン展開されるため、実行時に追加のオブジェクト参照が発生せず、高速に動作します。

2. より少ないコード生成

const enumは、コンパイル後のコードサイズを小さく保ちます。通常のenumでは、列挙型オブジェクトが生成されますが、const enumではこれが不要です。

使用例

数値 `const enum`

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

function move(direction: Direction) {
    switch (direction) {
        case Direction.Up:
            console.log("Moving up!");
            break;
        case Direction.Down:
            console.log("Moving down!");
            break;
        case Direction.Left:
            console.log("Moving left!");
            break;
        case Direction.Right:
            console.log("Moving right!");
            break;
    }
}

move(Direction.Up);   // "Moving up!"
move(Direction.Right); // "Moving right!"

このコードは以下のようにコンパイルされます。

function move(direction) {
    switch (direction) {
        case 0 /* Direction.Up */:
            console.log("Moving up!");
            break;
        case 1 /* Direction.Down */:
            console.log("Moving down!");
            break;
        case 2 /* Direction.Left */:
            console.log("Moving left!");
            break;
        case 3 /* Direction.Right */:
            console.log("Moving right!");
            break;
    }
}

move(0 /* Direction.Up */);   // "Moving up!"
move(3 /* Direction.Right */); // "Moving right!"

文字列 `const enum`

文字列const enumもサポートされています。

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

function move(direction: Direction) {
    switch (direction) {
        case Direction.Up:
            console.log("Moving up!");
            break;
        case Direction.Down:
            console.log("Moving down!");
            break;
        case Direction.Left:
            console.log("Moving left!");
            break;
        case Direction.Right:
            console.log("Moving right!");
            break;
    }
}

move(Direction.Up);   // "Moving up!"
move(Direction.Right); // "Moving right!"

このコードは以下のようにコンパイルされます。

function move(direction) {
    switch (direction) {
        case "UP" /* Direction.Up */:
            console.log("Moving up!");
            break;
        case "DOWN" /* Direction.Down */:
            console.log("Moving down!");
            break;
        case "LEFT" /* Direction.Left */:
            console.log("Moving left!");
            break;
        case "RIGHT" /* Direction.Right */:
            console.log("Moving right!");
            break;
    }
}

move("UP" /* Direction.Up */);   // "Moving up!"
move("RIGHT" /* Direction.Right */); // "Moving right!"

注意点

コンパイルオプション

const enumは、preserveConstEnumsコンパイルオプションを有効にしている場合を除き、コンパイル時に削除されます。このオプションを有効にすると、const enumも通常のenumと同様に扱われ、インライン展開されなくなります。

tsconfig.jsonの例：

{
  "compilerOptions": {
    "preserveConstEnums": false
  }
}

エラー回避

const enumのメンバーはインライン展開されるため、エラーをキャッチするのが難しくなることがあります。特に、定数値が変更された場合や、参照されるconst enumが削除された場合です。従って、const enumを使用する際には、定義の変更に注意が必要です。

まとめ

const enumは、TypeScriptで効率的な列挙型を提供する強力なツールです。インライン展開されるため、実行時のパフォーマンスが向上し、生成されるコードも少なくなります。ただし、const enumを使用する際には、コンパイルオプションや定義の変更に注意が必要です。

【TypeScript】 `const enum` について