Open2

【never型 Error】TypeScriptのexhaustive check（網羅性チェック）とは何か？

TypeScript
exhaustivecheck
網羅性チェック
まさぴょん🐱まさぴょん🐱

TypeScriptのexhaustive check（網羅性チェック）

TypeScriptのexhaustive check（網羅性チェック）とは、プログラム内で使用されるすべての可能な値が適切に処理されていることを確認するための機能です。
この機能は、特に分岐型（discriminated unions）やswitch文、if文を使用する際に重要です。以下にその詳細を説明します。

Exhaustive Checkの基本概念

網羅性の確認

TypeScriptでは、特定の型（例えば、列挙型やユニオン型）のすべての可能な値が処理されているかどうかをチェックします。
これにより、新しい値が追加された場合に、適切に処理されていないケースをコンパイル時に検出できます。

never型の利用

TypeScriptでは、never型を使用して、到達不可能なコードを示します。
例えば、switch文のdefaultケースでnever型の変数を使用することで、すべてのケースが処理されているかを確認できます。
もし新しい値が追加され、defaultケースに到達する場合、コンパイラはエラーを報告します。

具体例

以下は、exhaustive checkを利用したTypeScriptのコード例です。

- type Direction = 'up' | 'down';
+ type Direction = 'up' | 'down' | 'left';

const move = (direction: Direction) => {
    switch (direction) {
        case 'up':
            console.log('Moving up');
            break;
        case 'down':
            console.log('Moving down');
            break;
        default:
　　　// 例えば、"left"が増えた場合、上のcase文を増やさないと、
　　　// ここに到達する可能性が出てくるため、型エラーが発生する。
            const _exhaustiveCheck: never = direction;
            console.log(_exhaustiveCheck);
            throw new Error(_exhaustiveCheck);
    }
};

この例では、Direction型に新しい値（例えば、"left"）を追加すると、defaultケースでnever型の変数に代入しようとした際にエラーが発生します。
これにより、すべての可能な値が処理されていることが保証されます。

利点

  • バグの早期発見: 新しい値を追加した際に、忘れがちなケースをコンパイル時に検出できるため、バグを早期に発見できます。

  • コードの安全性向上: すべてのケースを考慮することで、実行時エラーを減少させ、より安全なコードを書くことができます。

TypeScriptのexhaustive checkは、特に大規模なアプリケーションや複雑なロジックを扱う際に非常に有用な機能です。これにより、開発者はより信頼性の高いコードを作成することができます。