【初心者向け】TypeScript超入門#05 ジェネリクス編
2020-07-05Content
はじめに
おはようございます!こんにちは!こんばんは! のふのふ(@rpf_nob)と申します!!都内のスタートアップでフロントエンドエンジニアとして働いています。
この記事は TypeScript 超入門シリーズの第 5 回目として、TypeScript のジェネリクスについてまとめて解説していきます!
ソースコードは以下 GitHub を参照してください。
ジェネリクスとは
ジェネリクスを使うと型の決定を実行時まで遅らせることができます。
わかりやすくいうと型を引数として受け渡すことで、同じような処理を極力減らして、汎用的で再利用可能な関数やクラスを作ることができる仕組みのことです。
関数のジェネリクス
基本的な書き方
まず、値を受け取りそのまま値を返す関数を作るとすると、以下のように[string 型]・[number 型]・[boolean 型]をそれぞれ作る必要がありますよね?
const echoString = (prm: string): string => {
return prm;
};
const echoNumber = (prm: number): number => {
return prm;
};
const echoBoolean = (prm: boolean): boolean => {
return prm;
};
console.log(echoString("Hello")); //Hello
console.log(echoNumber(32)); //32
console.log(echoBoolean(false)); //false
ジェネリクスを使うとこのように同じような処理を 1 つの関数で汎用的な関数を作ることができます。
以下のように、<T>
の部分で呼び出し元から型を受け取って、その関数内で使用できるようにできるのがジェネリクスの仕組みです。
const echo = <T>(prm: T): T => {
return prm;
};
呼び出し元からは以下のように関数名とパラメータの間に<string>
のように、使いたい型を指定してあげます。
console.log(echo<string>("Hello")); //Hello
console.log(echo<number>(32)); //32
console.log(echo<boolean>(false)); //false
これで汎用的な関数ができましたね。
このように実行するまで型の決定を送らせるのがジェネリクスの仕組みとなります。
初期ジェネリクス
関数のデフォルトパラメーターのように、<T = string>
のように書くと、実行時にジェネリクス型を指定しなくても、デフォルトの型で実行できます。
const echo2 = <T = string>(prm: T): T => {
return prm;
};
console.log(echo2("Hello")); //Hello
console.log(echo2<string>("Hello")); //Hello
console.log(echo2<number>(32)); //32
console.log(echo2<boolean>(false)); //false
extends による制約
extendsを付与することで、ジェネリクスに指定できる型を制約することができます。
次の例ではジェネリクスに指定できる型をstring 型のみに制約をつけているため、number 型やboolean 型は指定できません。
const echo3 = <T extends string>(prm: T): T => {
return prm;
};
console.log(echo3<string>("Hello")); //Hello
console.log(echo3<number>(32)); //NG→型 'number' は制約 'string' を満たしていません。
console.log(echo3<boolean>(false)); //NG→型 'number' は制約 'string' を満たしていません。
複数に制約を付けたい場合はstring | numberのように共用型にします。
const echo4 = <T extends string | number>(prm: T): T => {
return prm;
};
console.log(echo4<string>("Hello")); //Hello
console.log(echo4<number>(32)); //32
console.log(echo4<boolean>(false)); //NG→型 'number' は制約 'string' を満たしていません。
keyof を使ってオブジェクトのキーの共用型を作る
第二引数のジェネリクスを第一引数のジェネリクスと関連付けることもできます。 次の場合は、第一引数のオブジェクトのキーを第二引数の型として定義しています。
const echo5 = <T, U extends keyof T>(prm: T, key: U): T => {
console.log(prm[key]); //Hello
return prm;
};
console.log(echo5({ message: "Hello", id: 32 }, "message")); //{ message: 'Hello', id: 32 }
暗黙的に指定されるジェネリクス
関数定義にジェネリクスが含まれていても、実行時の型指定は必須ではなく、省略していてもパラメータの値から推論されて実行することができます。
以下のように、直接文字列をパラメータとして渡すと、echo関数はその文字列リテラル型に型推論され、オブジェクトとしてパラメータを渡すと、string 型に型推論されていることがわかります。
console.log(echo("Hello")); //Hello
//const echo: <"Hello">(prm: "Hello") => "Hello"
console.log(echo({ value: "Hello" }));
// const echo: <{
// value: string;
// }>(prm: {
// value: string;
// }) => {
// value: string;
// }
クラスのジェネリクス
クラスの宣言にジェネリクスを使用すると、コンストラクターの引数の型を制約することができます。次の例ではインスタンス生成時にstring 型とnumber 型の引数をしていできます。
class Echo<T extends string | number> {
constructor(public value: T) {}
echo(): T {
return this.value;
}
}
console.log(new Echo<string>("Hello").echo()); //Hello
console.log(new Echo<number>(128).echo()); //128
console.log(new Echo<boolean>(false).echo()); //NG→型 'boolean' は制約 'string | number' を満たしていません。
インターフェースのジェネリクス
インターフェースにもジェネリクスが使用できます。
interface Echo2<T> {
message: T;
}
const echo7: Echo2<string> = {
message: "Hello",
};
console.log(echo7);
const echo8: Echo2<number> = {
message: 32,
};
console.log({ message: 32 });
まとめ
今回は TypeScript のジェネリクスについて解説を行いました。
はじめてジェネリクスという名前を聞くと一見難しそうですが、一個ずつ順を追って理解していけばそんなに難しくないですよね!!
次回は型推論についてまとめていきたいと思います。
最後まで見ていただきありがとうございました!! この記事が良かったと思ったら SHARE していただけると泣いて喜びます 🤣