TypeScript 型ガード

型ガード(Type Guards)は、TypeScript において非常に重要な型の絞り込みメカニズムです。

これにより、開発者は実行時に特定の条件チェックを行うことで、TypeScript コンパイラが変数の具体的な型を正確に推論できるようになります。

型ガードを利用すると、ユニオン型変数内の特定の型のプロパティやメソッドに安全にアクセスできます。


なぜ型ガードが必要か

TypeScript では、変数が複数の型のユニオンとして宣言されることがあります。

型に応じて異なる操作を実行する必要がある場合、コンパイラは現在の具体的な型を自動的に判断できません。

型ガードは、この問題を解決するための重要なメカニズムです。

概念の説明:型ガードの核となる原理は「型の絞り込み」(Type Narrowing)です。条件判断により、TypeScript はユニオン型を自動的に具体的な型へ絞り込みます。


SVG 図解:型ガードのフロー 背景 タイトル 型ガード - 型の絞り込みフロー 左側:ユニオン型 元のユニオン型 string | number | boolean 矢印1 typeof 中央:typeof string typeof === "string" string に絞り込み 矢印2 分岐 右側:結果 型が確定 .length にアクセス可能 下半分:型ガードの種類 型ガードの方法 方法1 typeof typeof x === "string" プリミティブ型 方法2 instanceof x instanceof Array クラスインスタンス 方法3 カスタムガード x is String value is Type 方法4 in "prop" in x プロパティチェック 矢印マーク

typeof 型ガード

typeof は最も一般的な型ガードで、プリミティブ型(string、number、boolean など)のチェックに使用されます。

これは値の型を表す文字列を返します。

typeof の基本的な使い方

// ユニオン型を受け取る関数を定義
// 引数 value は文字列または数値の可能性がある
function printValue(value: string | number): void {
    // typeof を使って型をチェック
    // if 条件が true の場合、TypeScript は自動的に value を string 型に絞り込む
    if (typeof value === "string") {
        // このとき TypeScript は value が string であると認識する
        // 文字列の length プロパティに安全にアクセスできる
        console.log("文字列の長さ: " + value.length);
    } else {
        // else 分岐に入ると、TypeScript は value が string ではないと認識する
        // number 型のみとなる
        // 安全に数値演算を行える
        console.log("数値を2倍: " + (value * 2));
    }
}

// テスト呼び出し
printValue("hello");  // 文字列を渡す
printValue(42);       // 数値を渡す

実行結果:

字符串长度: 5
数字翻倍: 84

typeof がサポートする型:

  • "string"- 文字列型
  • "number"- 数値型(NaN と Infinity を含む)
  • "boolean"- 真偽値型
  • "undefined"- undefined 型
  • "object"- オブジェクト型(注意:配列と null も "object" として認識されます)
  • "function"- 関数型

注意:typeof は配列と null に対してどちらも "object" を返します。配列とオブジェクトを正確に区別する必要がある場合は、別の方法を使用する必要があります。


instanceof 型ガード

instanceof は、オブジェクトが特定のクラスのインスタンスであるかをチェックするために使用します。

これはオブジェクトのプロトタイプチェーンを調べて型を判定します。

instanceof の基本的な使い方

// Dog クラスを定義
class Dog {
    // 犬の鳴き声メソッド
    bark(): void {
        console.log("ワンワン!");
    }
}

// Cat クラスを定義
class Cat {
    // 猫の鳴き声メソッド
    meow(): void {
        console.log("ニャーニャー!");
    }
}

// ユニオン型を受け取る関数
function makeSound(animal: Dog | Cat): void {
    // instanceof を使って animal が Dog か Cat かをチェック
    // if 条件が true の場合、TypeScript は animal を Dog 型に絞り込む
    if (animal instanceof Dog) {
        // このとき Dog 固有のメソッドを呼び出せる
        animal.bark();
    } else {
        // else 分岐では、TypeScript は animal を Cat 型に絞り込む
        animal.meow();
    }
}

// テスト呼び出し
makeSound(new Dog());  // Dog インスタンスを作成して呼び出し
makeSound(new Cat());  // Cat インスタンスを作成して呼び出し

実行結果:

ワンワンワン!
ニャンニャンニャン!

説明:

instanceof はオブジェクトのプロトタイプチェーンをチェックするため、クラスインスタンスにのみ使用でき、インターフェースや型エイリアスには使用できません。


カスタム型ガード

組み込みの typeof や instanceof で要件を満たせない場合、カスタム型ガード関数を作成できます。

カスタム型ガードはvalue is Typeの戻り値型構文を使用します。

カスタムガード関数

// カスタム型ガード関数を定義
// 戻り値型は "value is Type" 形式を使用
// これは TypeScript に「関数が true を返すとき、引数の型は string である」ことを伝える
function isString(value: any): value is string {
    // typeof を使って文字列かどうかをチェック
    return typeof value === "string";
}

// 別のカスタムガード:数値かどうかをチェック
function isNumber(value: any): value is number {
    return typeof value === "number";
}

// 配列型のガードを定義
function isArray(value: any): value is any[] {
    return Array.isArray(value);
}

// 値を処理する関数
function processValue(value: string | number | any[]): void {
    // カスタムガードを使って型チェック
    if (isString(value)) {
        // TypeScript は value が string 型であると認識
        // toUpperCase() メソッドを呼び出せる
        console.log("文字列を大文字に: " + value.toUpperCase());
    } else if (isNumber(value)) {
        // TypeScript は value が number 型であると認識
        // toFixed() メソッドを呼び出せる
        console.log("数値のフォーマット: " + value.toFixed(2));
    } else if (isArray(value)) {
        // TypeScript は value が配列型であると認識
        console.log("配列の長さ: " + value.length);
    }
}

// テスト呼び出し
processValue("hello");
processValue(3.14159);
processValue([1, 2, 3, 4, 5]);

実行結果:

字符串转大写: HELLO
数字格式化: 3.14
数组长度: 5

ヒント:カスタム型ガードの鍵は戻り値型value is Type、これは TypeScript が型ガードを認識するための目印です。


in 演算子の型ガード

in 演算子は、オブジェクトが特定のプロパティを含むかどうかをチェックできます。

条件判断で in を使用すると、TypeScript は自動的にオブジェクトの型の範囲を絞り込みます。

in 演算子の使い方

// 異なるプロパティを持つ2つのインターフェースを定義
interface A {
    a: string;  // プロパティ a のみ
}

interface B {
    b: number;  // プロパティ b のみ
}

// ユニオン型を受け取る関数
function process(obj: A | B): void {
    // in を使ってオブジェクトがプロパティ "a" を含むかチェック
    if ("a" in obj) {
        // if 分岐では、TypeScript は obj がプロパティ a を含むと認識
        // したがって obj の型は A に絞り込まれる
        console.log("A のプロパティ a: " + obj.a);
    } else {
        // else 分岐では、obj はプロパティ a を含まない
        // TypeScript は obj が B 型のみであると認識
        // したがってプロパティ b に安全にアクセスできる
        console.log("B のプロパティ b: " + obj.b);
    }
}

// テスト呼び出し
process({ a: "hello" });  // 属性aを含むオブジェクトを渡す
process({ b: 42 });       // 属性bを含むオブジェクトを渡す

実行結果:

A 的属性 a: hello
B 的属性 b: 42

判別可能なユニオンと型ガード

判別可能なユニオンは強力なパターンであり、共通の「識別」プロパティを通じてユニオン型のメンバーを区別します。

switch文またはif判断と組み合わせることで、完全な型ガードを実現できます。

判別可能なユニオンによる電卓の実装

// 円形インターフェースを定義し、kindプロパティを識別子として使用
interface Circle {
    kind: "circle";       // 識別フィールド: 値は "circle"
    radius: number;       // 半径
}

// 矩形インターフェースを定義
interface Rectangle {
    kind: "rectangle";    // 識別フィールド: 値は "rectangle"
    width: number;        // 幅
    height: number;      // 高さ
}

// 三角形インターフェースを定義
interface Triangle {
    kind: "triangle";    // 識別フィールド: 値は "triangle"
    base: number;        // 底辺
    height: number;      // 高さ
}

// ユニオン型を定義
type Shape = Circle | Rectangle | Triangle;

// 面積を計算する関数
function getArea(shape: Shape): number {
    // switch文を使用して型ガードを行う
    // kindプロパティの値に基づいて、TypeScriptは自動的に型を絞り込む
    switch (shape.kind) {
        case "circle":
            // shapeはCircle型に絞り込まれる
            // radiusプロパティにアクセスできる
            return Math.PI * shape.radius ** 2;

        case "rectangle":
            // shapeはRectangle型に絞り込まれる
            // widthとheightプロパティにアクセスできる
            return shape.width * shape.height;

        case "triangle":
            // shapeはTriangle型に絞り込まれる
            return 0.5 * shape.base * shape.height;
    }
}

// テスト呼び出し
var circle = { kind: "circle" as const, radius: 5 };
var rectangle = { kind: "rectangle" as const, width: 4, height: 6 };
var triangle = { kind: "triangle" as const, base: 3, height: 4 };

console.log("円の面積: " + getArea(circle).toFixed(2));
console.log("矩形の面積: " + getArea(rectangle));
console.log("三角形の面積: " + getArea(triangle));

実行結果:

圆形面积: 78.54
矩形面积: 24
三角形面积: 6

説明:判別可能なユニオンは、TypeScriptで最も推奨されるパターンの1つです。共通のリテラルプロパティ(通常はkindまたはtype)を通じて異なる型メンバーを区別し、コードを型安全かつ保守しやすくします。


null と undefined のチェック

nullまたはundefinedの可能性がある値を処理する場合、直接の等価性チェックも有効な型ガードです。

null チェック

// nullの可能性がある関数パラメータを定義
function getLength(str: string | null): number {
    // strがnullでないことを直接チェック
    // 条件がtrueの場合、TypeScriptはstrがnullでないことを認識する
    // この時点でstrのプロパティに安全にアクセスできる
    if (str !== null) {
        return str.length;
    }

    // nullの場合の処理
    return 0;
}

// テスト呼び出し
console.log(getLength("hello"));  // 通常の文字列
console.log(getLength(null));      // nullを渡す

実行結果:

5
0

ヒント:strictNullChecksを有効にした後は、常にnullチェックを行うことをお勧めします。オプショナルチェーン(?.)とnull合体演算子(??)を使用してコードを簡素化できます。


真値による絞り込み

明示的な型チェックに加えて、TypeScriptは真値評価(Truthiness)によっても型の範囲を絞り込みます。

真値による絞り込み

// undefinedの可能性がある文字列
function greet(name?: string): string {
    // 短絡演算子を使用: nameがundefinedまたは空文字列の場合、デフォルト値を使用
    // && の後のコードブロックでは、TypeScriptはnameに必ず値があることを認識する
    return name && "Hello, " + name;
}

// テスト
console.log(greet("サンプル"));
console.log(greet());

実行結果:

Hello, サンプル
Hello, undefined

注意事項

  • 型ガードは条件分岐内で使用する必要があります:型ガードを使用して条件判断を行った後にのみ、TypeScriptは型の絞り込みを行います
  • 戻り値の型は型述語である必要があります:カスタム型ガードの戻り値の型は次の形式である必要があります:value is Type形式
  • 判別可能なユニオンはベストプラクティスです:複雑なユニオン型については、判別可能なユニオンパターンの使用を推奨します
  • 型の絞り込みの完全性に注意してください:switch文を使用する場合、すべての可能な分岐を処理することを推奨します

推奨:ユニオン型を処理する際は、判別可能なユニオンパターンの使用を優先的に検討してください。コードがより明確になるだけでなく、TypeScriptの型推論能力を最大限に活用できます。


まとめ

型ガードはTypeScriptの型システムの重要な構成要素です。

  • typeof:最も一般的な方法で、プリミティブ型のチェックに適しています
  • instanceof:オブジェクトが特定のクラスのインスタンスであるかをチェックします
  • カスタムガード:次の構文を通じてvalue is Type柔軟な型チェックを実現します
  • in:オブジェクトが特定のプロパティを含むかをチェックします
  • 判別可能なユニオン:推奨されるベストプラクティスパターンで、識別フィールドを通じて型を区別します
  • 真値による絞り込み:JavaScriptの真値評価を利用して型を絞り込みます
その他の拡張