アサーション関数とユーザー定義型ガード
アサーション関数(asserts x is T)とユーザー定義型ガード(x is T)を記述し、unknownやunionの値を安全に絞り込みます
「アサーション関数とユーザー定義型ガード」はCoddyKit上の無料TypeScript Academyレッスンです。 これはレッスン3/3です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。 これはTypeScript Academy学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 TypeScript Academyコースには全3レッスンが含まれています。
導入
目標:アサーション関数とユーザー定義型ガードを使って、実行時チェックを型の絞り込みに変換し、安全なAPIを作成します。
アサーション関数
アサーション関数は、関数が戻った場合に後続のコードで型を絞り込みます。戻らない場合は、必ず例外を投げる必要があります。
function assertIsString(x: unknown): asserts x is string {
if (typeof x !== "string") {
throw new Error("Expected string");
}
}
let v: unknown = Math.random() > 0.5 ? "ok" : 42;
assertIsString(v); // after this, v is string
console.log(v.toUpperCase());型ガード関数
型ガードはx is Tを返し、分岐やヘルパー関数でスマートな絞り込みを可能にします。
type Circle = { kind: "circle"; radius: number };
type Square = { kind: "square"; size: number };
type Shape = Circle | Square;
function isCircle(s: Shape): s is Circle {
return s.kind === "circle";
}
function area(s: Shape): number {
if (isCircle(s)) {
return Math.PI * s.radius ** 2; // s is Circle here
}
return s.size * s.size; // s is Square here
}
console.log(area({ kind: "circle", radius: 2 }));filterでのガード
ガードは、配列メソッド(例:filter)で要素の型をきれいに絞り込むための述語として使用できます。
type Item = { id: number } | null | undefined;
function isPresent<T>(x: T | null | undefined): x is T {
return x != null;
}
const items: Item[] = [{ id: 1 }, null, undefined, { id: 2 }];
const present = items.filter(isPresent);
// present has type { id: number }[]
console.log(present.map(i => i.id));実行時データへのアサーション
パースとアサーションを組み合わせ、値が想定した型でない場合にすぐ失敗するようにします。
function parseJson(s: string): unknown {
return JSON.parse(s);
}
try {
const data = parseJson("{\"name\":\"Ada\"}");
assertIsString(data); // will throw, because data is object
} catch (e) {
console.log("Handled:", e instanceof Error ? e.message : e);
}ガイドライン
ガイドライン:
- アサーションは、失敗時に必ず例外を投げる必要があります。
- 分岐ロジックには、
x is Tのガードを優先してください。 - APIの境界(I/O、JSON、DOM)でアサーションを使ってください。
アサーション関数の確認
クイックチェック:asserts x is stringを持つアサーション関数は何を保証しますか?
まとめ
まとめ:チェック後の型を保証するにはアサーション関数を使い、分岐やコレクションの型を絞り込むにはユーザー定義型ガードを使います。
よくある質問
「アサーション関数とユーザー定義型ガード」レッスンは無料ですか?
はい。「アサーション関数とユーザー定義型ガード」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し(組み込みコードエディタと24時間対応のAIチューター)、TypeScript Academyコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 TypeScript Academyコースには全3レッスンが含まれています。
「アサーション関数とユーザー定義型ガード」で何を学びますか?
アサーション関数(asserts x is T)とユーザー定義型ガード(x is T)を記述し、unknownやunionの値を安全に絞り込みます ブラウザで直接実行するハンズオンコードでTypeScript Academyを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。
TypeScript Academyを始めるのに経験は必要ですか?
事前経験は必要ありません。CoddyKitのTypeScript Academyは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。 これはレッスン3/3です。
「アサーション関数とユーザー定義型ガード」レッスンにはどのくらい時間がかかりますか?
ほとんどのCoddyKitレッスンは約5~10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。
このTypeScript Academyレッスンでコードを書いて実行できますか?
はい。すべてのTypeScript Academyレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。
このコースのすべてのレッスン
- 関数オーバーロードとcall signature
- thisパラメーターの型付け、void、never
- アサーション関数とユーザー定義型ガード