ジェネリクス
ジェネリクス(generics)は、型を後から差し替えられる仕組みです。配列やPromiseのように「中身の型は状況によって変わるが、構造は共通」というパターンを表現するために使います。
Array<T> と Promise<T> の見方
TypeScriptのコードで頻出する Array<T> は「T の配列」、Promise<T> は「T を解決するPromise」を意味します。角括弧に似た <> の中に入れた型が、その汎用的な型の「中身」を指定します。
const scores: Array<number> = [80, 90, 75];
const request: Promise<string> = fetch("https://example.com").then((r) => r.text());
Array<T> は T[] と等価なので、単純な配列型は T[] の書き方でよく、Promise<T> は書き換えの効かない専用の形として頻出します。
1. ジェネリクス関数の自作
任意の値を受け取り、そのまま返す関数を考えてみます。引数の型と戻り値の型が同じであることを表現したい場合、any を使うと型情報が失われてしまいます。
function identity(value: any): any {
return value;
}
const result = identity("hello");
この場合 result は any になってしまい、.toUpperCase() などのメソッドの候補も出てきません。呼び出し側で決まる型をそのまま戻り値に反映したいときは、ジェネリクスを使います。書き方は以下のとおりです。
function 関数名<型パラメータ>(引数名: 型パラメータ): 戻り値の型 {
// 処理
}
次のコードは、渡された値をそのまま返す関数を、ジェネリクスで型を保ったまま実装した例です。以下のコードで hello.ts を書き換えます。
function identity<T>(value: T): T {
return value;
}
const text = identity<string>("hello");
const num = identity<number>(123);
console.log(text.toUpperCase());
console.log(num.toFixed(0));
以下のコマンドでコンパイルします。
npx tsc hello.ts
続いて、生成された hello.js を実行します。
node hello.js
以下のような実行結果が表示されます。
HELLO
123
identity<string>("hello") は text を string として扱うため toUpperCase() が呼べ、identity<number>(123) は num を number として扱うため toFixed(0) が呼べます。
コードを解説します。
function identity<T>(value: T): T {
return value;
}
<T> で「呼び出し時に決まる型」の目印を宣言し、value の型と戻り値の型の両方に T を使っています。これにより、渡した値の型がそのまま戻り値の型として引き継がれます。
<T> の T は型のパラメータで、名前は自由に付けられます。T(Type)・U・K(Key)・V(Value)などが慣例的に使われます。呼び出し側で identity<string>("hello") のように型を明示するか、TypeScriptの推論に任せて identity("hello") と書くこともできます。
2. よく使うユーティリティ型
TypeScriptにはあらかじめ定義されたユーティリティ型が多数用意されています。すべて覚える必要はありませんが、以下の4つは実際の開発で頻繁に登場するので、それぞれ動きを確認します。詳しい種類は Utility Types(TypeScript公式ドキュメント) に記載があります。
Record<K, V>
キーの型と値の型を指定して、そのペアからなるオブジェクトの型を作りたいときは、Record<K, V> を使います。書き方は以下のとおりです。
Record<キーの型, 値の型>
次のコードは、Status の各値に対応するラベル文字列を持つオブジェクトを、Record で型付けする例です。以下のコードで hello.ts を書き換えます。
const statusLabels: Record<"success" | "error" | "loading", string> = {
success: "成功",
error: "エラー",
loading: "読み込み中",
};
console.log(statusLabels.success);
以下のコマンドでコンパイルします。
npx tsc hello.ts
続いて、生成された hello.js を実行します。
node hello.js
以下のような実行結果が表示されます。
成功
statusLabels.success に対応する "成功" が出力されました。
コードを解説します。
const statusLabels: Record<"success" | "error" | "loading", string> = {
success: "成功",
error: "エラー",
loading: "読み込み中",
};
キーの型を "success" | "error" | "loading" のリテラル型のユニオン、値の型を string にしています。この型を持つオブジェクトは、指定した3つのキーをすべて備え、それ以外のキーは許容されないため、キーの取りこぼしや誤字をコンパイル時に防げます。
Partial<T>
既存の型のすべてのプロパティを省略可能にした型を作りたいときは、Partial<T> を使います。書き方は以下のとおりです。
Partial<型名>
次のコードは、User のプロパティを部分的に更新する updateUser 関数を、Partial<User> で受け取る例です。以下のコードで hello.ts を書き換えます。
interface User {
id: number;
name: string;
email: string;
}
function updateUser(id: number, patch: Partial<User>) {
console.log(`user ${id} を更新:`, patch);
}
updateUser(1, { email: "new@example.com" });
以下のコマンドでコンパイルします。
npx tsc hello.ts
続いて、生成された hello.js を実行します。
node hello.js
以下のような実行結果が表示されます。
user 1 を更新: { email: 'new@example.com' }
email プロパティだけを渡した patch がそのまま出力されました。
コードを解説します。
function updateUser(id: number, patch: Partial<User>) {
patch の型として Partial<User> を指定しています。この型は User のすべてのプロパティを省略可能(? 付き)にした形で、「一部だけを更新する」用途にちょうど合います。
Pick<T, K>
既存の型から特定のプロパティだけを取り出した型を作りたいときは、Pick<T, K> を使います。書き方は以下のとおりです。
Pick<型名, "プロパティ名1" | "プロパティ名2">
次のコードは、User から id と name だけを取り出した UserSummary を定義する例です。以下のコードで hello.ts を書き換えます。
interface User {
id: number;
name: string;
email: string;
}
type UserSummary = Pick<User, "id" | "name">;
const summary: UserSummary = { id: 1, name: "田中太郎" };
console.log(summary);
以下のコマンドでコンパイルします。
npx tsc hello.ts
続いて、生成された hello.js を実行します。
node hello.js
以下のような実行結果が表示されます。
{ id: 1, name: '田中太郎' }
UserSummary の形に沿った id と name だけのオブジェクトが出力されました。
コードを解説します。
type UserSummary = Pick<User, "id" | "name">;
Pick<User, "id" | "name"> は、User から id と name のプロパティだけを取り出した型を生成します。一覧表示など、必要最小限の情報だけを持つ型が欲しい場面で使います。
Omit<T, K>
既存の型から特定のプロパティを除いた型を作りたいときは、Omit<T, K> を使います。書き方は以下のとおりです。
Omit<型名, "プロパティ名1" | "プロパティ名2">
次のコードは、User から id を除いた NewUserInput を定義し、新規作成時の入力型として使う例です。IDは関数内で採番するため、入力側では受け取らない前提です。以下のコードで hello.ts を書き換えます。
interface User {
id: number;
name: string;
email: string;
}
type NewUserInput = Omit<User, "id">;
function createUser(input: NewUserInput): User {
const newId = Date.now();
return { id: newId, ...input };
}
const created = createUser({ name: "山田花子", email: "yamada@example.com" });
console.log(created);
以下のコマンドでコンパイルします。
npx tsc hello.ts
続いて、生成された hello.js を実行します。
node hello.js
以下のような実行結果が表示されます。
{ id: 1721196000000, name: '山田花子', email: 'yamada@example.com' }
呼び出し側では id を渡さず name と email だけを指定し、関数内で採番された id を含む User が返っています。
コードを解説します。
type NewUserInput = Omit<User, "id">;
Omit<User, "id"> は、User から id を除いたプロパティで構成される型を生成します。createUser の引数 input の型として使うことで、呼び出し側が誤って id を渡そうとするとコンパイル時にエラーになり、「id は関数内で必ず採番される」ことを型で担保できます。