目次 (8)
[Typescript] Type Narrow & CFA
TypeScriptは、"string" | "number"のようなユニオン型について、CFA(Control Flow Analysis)とユーザー定義関数によって型をType Narrowし、その結果を開発者に見せてくれます。
Control Flowは日本語で言うと制御フローで、プログラムで実行される各文、命令や関数が呼び出される順序を意味します。制御フローを表す文は、ある条件に応じて実行するか省略するかを決め、呼び出し順序や流れを変えられるようにする文で、制御文と呼ばれます。代表的なboolean logicの制御文としては、if、switch、tryのような文があります。純粋なJavaScriptのコードを分析するのと同じです。
ユーザー定義関数とは、"is"、"assert"、"infer"、"as"のようなキーワードや型Genericを使った型、あるいは型関数です。CFAによって型が決まるのと異なる点は、TypeScriptのキーワードはコンパイル後にはすべて消えるということです。
ポイントは、CFAはJavaScriptのコードによっても型が制御されるためランタイムに影響を与えますが、ユーザー定義関数による型はランタイムに影響を与えないということです。
1. Type Narrow by natural javascript [If制御文]
最も簡単な型の絞り込み方法としては、JavaScriptのIf文とJavaScriptの型演算子があります。型演算子の種類は大きく3つあります。typeof、in、instanceofです。それぞれPrimitive+ built-in Type、Object、Classを区別するのに使います。区別したい変数の種類によって、型を絞り込む方法が異なります。
1.1 Primitive & built-in Type Narrow (typeof演算子)
Primitive値にはstring、number、boolean、symbolなどがあります。そしてこれらの型は、typeof演算子を使って変数の型を調べ、if文で型を絞り込むことができます。"object"のようなbuilt-inのJavaScript型も
declare const getUserAge: () => undefined | number;const age = getUserAge(); // undefined | number;if (typeof age === 'undefined') return; // ageがundefinedならreturnします => 次の行からunion型から除外されます。const koreanAge = age + 1; // number;1.2 Object Type Narrow (in演算子)
2つのObjectがあるとき、2つのObjectが同じかどうかを確認するには、同じPropertyがあるかを確認する必要があります。JavaScriptでこれを確認するには、該当するProperty Keyを持っているかどうかを直接確認しなければなりません。そのための演算子がinです。
// 1. 異なるオブジェクトのkey値の比較declare const getUserAge: () => {value: number} | {error: Error};const age = getUserAge(); // {value: number} | {error: Error};if ("error" in age) return; // "error"がpropertyとしてあれば終了。const koreanAge = age.value + 1; // {value: number}// 2. 異なるオブジェクトのkey & value typeの比較。declare const getUserAge: () => | {value: number} | {value: undefined} | {error: Error};const age = getUserAge(); // {value: number} | {value: undefined} | {error: Error};if ("error" in age) return; if (typeof age.value === 'undefined') return; // {value: number} | {value: undefined}const koreanAge = age.value + 1; // {value: number}1.3 Class Type Narrow (instanceof演算子)
クラスは継承して拡張できます。継承したクラスがSubClass、継承させるクラスがSuperClassになります。そして、このSubClassで生成されたオブジェクトはSubClassのインスタンスでもありますが、SuperClassのインスタンスにもなり得ます。instanceof演算子は、インスタンスのプロトタイプチェーンの中にClassのプロトタイプと同じオブジェクトがあるかを確認するため、インスタンスのコンストラクタクラスのすべてのSuperClassと比較した場合にtrueになります。そしてTypeScriptは、instanceofとifを分析してType Narrowを行います。
instanceof判定基準の参考コード.ts
class User { age: number; constructor(age: number) { this.age = age; }}class MVPUser extends User { money: number; constructor(age: number, money: number) { super(age); this.money = money; }}const commonUser = new User(20);const richUser = new MVPUser(21, 1000);if (richUser instanceof User) { console.log("i am user") // 出力}if (commonUser instanceof User) { console.log("i also user") // 出力}if (commonUser instanceof MVPUser) { console.log("am i rich user?") // X}if (richUser instanceof MVPUser) { console.log("i am rich user") // 出力}if (commonUser instanceof Object) { console.log("i also Object") // 出力}if ('age' in richUser) { console.log("i also object2") // 出力}declare const getNumberOrNumbers: () => number | number[];const value = getNumberOrNumbers(); // number | number[]if (value instanceof Array) { console.log(value .length); // number[]} else { console.log(value .toPrecision(0)) // number}1.4 JavaScriptの基本type-guard関数
ArrayクラスとisArray関数は、基本のtype-guard関数の例の1つです。
declare const getNumberOrNumbers: () => number | number[];const myNum = getNumberOrNumbers(); // number | number[] ;if (Array.isArray(myNum)) { console.log(myNum.length); // number[]} else { console.log(myNum.toPrecision(0)) // number}1.5 比較演算子でUnion typeをnarrowする
1つ目の例はliteral typeをif文と比較演算子でnarrowしたもので、2つ目の例は、nameという同じkeyを共有するObjectの中でも、そのliteral値を利用してtype narrowを行った例です。
litral type narrow.ts
declare const getSomething: () => "日本語1" | "日本語2" | 3;const something = getSomething(); // number | number[] ;switch (something) { case "日本語1": console.log(something + "ストリング"); // "日本語1" break; case "日本語2": console.log(something + "ストリング2"); // "日本語2" break; default: console.log(something + 10); // 3}if (something === 3) { console.log("数字", something) // 3} else { console.log("文字", something + "ストリング3") // "日本語1" | "日本語2"}Discriminated Unions.ts
type Circle = { name: "circle"; radius: number;}type Square = { name: "square"; width: number;}type Diagram = Circle | Squarefunction getArea(diagram:Diagram) { switch(diagram.name) { case "circle": return diagram.radius * diagram.radius * 3.14; // Circle case "square": return diagram.width * diagram.width; // Square default: return 0; }}2. 型ガード(Type Guards)、型アサーション(Assertion)、
目次1でやったことは、実はすべて型ガードです。型ガードとは、複数の型になり得る変数で、その型を絞り込んでいくことです。
以下で説明する型ガードはユーザー定義型ガードです。type predicate(型判別)キーワード"is"を使います。
型アサーション(表明)は、必ずある型でなければならないことを宣言するものです。コードでも該当する変数を確認し、望む型でなければ思い切ってErrorを投げるように作ってこそ、しっかりと型を管理できます。asまたはassert指示子を使ってアサーションできます。ThirdPartyを使う場合に、型定義がなくてやむを得ず使うケースが多いです。あるいは、型が複雑になりすぎるなら、いっそasを使うのも開発コストを減らすのに役立つと思います。
Type Guard(ユーザー定義)
実はinstanceofを使えば、obj is LayoutErrorと書かなくても、CFAによって自動的に推論されます。
declare const getError: () => NetworkError | LayoutError;class NetworkError extends Error { retryCount: number;};class LayoutError extends Error { target: string;};function isLayoutError(obj: Error): obj is LayoutError { return obj instanceof LayoutError;}const error = getError(); // NetworkError | LayoutErrorif (isLayoutError(error)) { console.error(error.target,"ここでレイアウトエラー") //LayoutError} else { console.error("リトライ回数 :", error.retryCount) //NetworkError}紛らわしいType Guard
型ガードはLayoutErrorにすべきだったのに、おかしな書き方をして入れ替わってしまった状況です。TS Errorなしで動作します。
declare const getError: () => NetworkError | LayoutError;class NetworkError extends Error { retryCount: number;};class LayoutError extends Error { target: string;};function isLayoutError(obj: Error): obj is NetworkError { return obj instanceof LayoutError;}const error = getError(); // NetworkError | LayoutErrorif (isLayoutError(error)) { console.error(error.target,"ここでレイアウトエラー") // NetworkError開発者がobj is NetworkErrorと書いてしまったため、型推論の結果が変わってNetworkError型になりました。} else { console.error("リトライ回数 :", error.retryCount) // LayoutError}Assertion Function (asserts)
assertを使った場合、その関数の実行後は必ず型がassertした型として自動的に推論されます。そのため、もしJavaScriptのチェック結果がそうでない場合には、いっそErrorを投げてしまうコードを入れました。なくても動作はしますが、上の例のように型の安全性は保証されません。
declare const getError: () => NetworkError | LayoutError;class NetworkError extends Error { retryCount: number;};class LayoutError extends Error { target: string;};function assertLayoutError(obj: Error): asserts obj is LayoutError { if (!(obj instanceof LayoutError)) throw new Error("必ずLayoutErrorが来るって言ったじゃないですか!!")}const error = getError(); // NetworkError | LayoutErrorassertLayoutError(error); console.log(error.target) // LayoutError;Assertion (as)
// 例1 一般的な型アサーション。interface fruite { name: string; price: number;}var apple = {} as fruite;// 例2 MouseEventはEventのSubclassである。TypeScriptが認めてくれる型アサーションなので、エラー表示が出ない。(DownCasting)function onClick (event: Event) { let mouseEvent = event as MouseEvent;}// 例3 ダウンキャストでもアップキャストでもないため、そのまま型変換するとTS Errorメッセージが表示される。unknownを経由して変換する必要がある。// もちろんtsConfigの設定によって異なるinterface Message { content : string;}function onReceive(msg: Message) { let messageReceived = event as unkown as string;}as const
as constは、Objectのプロパティがnon-literalなkey-value型に拡張されるのを防ぐ役割をします。簡単に言うと、Objectをliteralバージョンにします。
const data1 = { name: "carrot"};const data2 = { name: "carrot"} as const;type Common = typeof data1[keyof typeof data1]; // stringtype Litral = typeof data2[keyof typeof data2]; // "carrot"