Discriminate Types
共用型の識別とは
コードフロー解析で可能性のあるオブジェクトの種類を
特定の1つのオブジェクトに減らすのに使うものです。
このパターンは異なる文字列や数字の定数を持つ
よく似たオブジェクトの集合に対してよく機能します。
例: 名前付きイベントのリストや
バージョン付けされたオブジェクトの集合
type TimingEvent = { name: "start"; userStarted: boolean } | { name: "closed"; duration: number };
const handleEvent = (event: TimingEvent) => {
// event.nameに対してswitch文を用いることで、
// TypeScriptのコードフロー解析はオブジェクトが
// 共用型のうちの片方で表せるということを確定できます。
switch (event.name) {
case "start":
// TimingEventのうち、nameが"start"になる型は1つしかないので、
// これはuserStartedに
// 安全にアクセスできることを意味します。
const initiatedByUser = event.userStarted;
break;
case "closed":
const timespan = event.duration;
break;
}
};
type APIResponses = { version: 0; msg: string } | { version: 1; message: string; status: number } | { error: string };
const handleResponse = (response: APIResponses) => {
// エラーの場合をハンドリングし、returnします。
if ("error" in response) {
console.error(response.error);
return;
}
// TypeScriptはここではAPIResponseがエラー型にならないことを知っています。
// もし、エラーであればこの関数はreturnされています。
// これは、以下のresponseに
// マウスホバーすると確認できます。
if (response.version === 0) {
console.log(response.msg);
} else if (response.version === 1) {
console.log(response.status, response.message);
}
};