Kgtkr's Blog

TypeScript、型レベルプログラミングエラー抑制テクニック

2019/04/15
typescripttypelevelprogramming

TypeScriptの型レベルプログラミングでは様々な型エラーが発生するため、それを抑制しながら作っていかなければいけません。
今回はエラーを回避するテクニックを2つ紹介します。
v3.4.2で動作確認をしています。

型制約エラーを抑制する

TSには型の型のようなものがあり、それを満たす型にしかできないような操作があります。
いくつか例を挙げます。

type F<T extends any[]> = T;
type X = F<A>;// Aはany[]を継承していなければいけない
type Y = B["x"]// Bはオブジェクト型で`x`というプロパティを持っていなければいけない

しかしこのような条件を満たしていることが分かっていてもコンパイラが推論出来ておらずエラーになることがあります。
そのような時は以下のようなCast型を定義して使いましょう。
これはTPを継承している時は分かっている時にCast<T, P>と書いて使います。

type Cast<T, P> = T extends P ? T : P;

例です。

type F<T> = "x" extends keyof T ? T : { x: 1 };
type G<T> = F<T>["x"];

F<T>の結果はxというプロパティを持っている事が分かっているのに型エラーになります。
そこで以下のように書き直すことでエラーを回避出来ます。

type G<T> = Cast<F<T>, { x: any }>["x"];

Type instantiation is excessively deep and possibly infinite.を抑制する

このエラーは二種類あり、型パラメーターが存在しない、つまり全ての型が解決された状態で出るものと、解決されていない型が存在する状態で出るものがあります。
前者は単純に再帰制限に引っかかっているため抑制することは出来ませんが、後者であれば抑制する事が出来ます。
FGが再帰などを含む複雑な型コンストラクタの時以下のように書くとエラーが発生します。

type X<T> = G<F<T>>;

ただしGはそこまで複雑でなくても出ることもあります。(要調査)
この時以下のように書くことで解決します。

type X<T> = G<F<T> extends infer A ? A : never>;

ただし複雑な型コンストラクタは型のチェックも上手く行えないことが多いのでCastと一緒に使うことが多いです。

type X<T> = G<F<T> extends infer A ? Cast<A, any[]> : never>;

TS3.4でここらへんの検査が厳しくなったらしく、このテクニックがほぼ必須になりました。
issue

エラーが出る具体例は以下のような感じです。

type Head<T extends any[], D = never> = T extends [infer X, ...any[]] ? X : D;
type Tail<T extends any[]> = ((...x: T) => void) extends ((x: any, ...xs: infer XS) => void) ? XS : never
type Cons<X, XS extends any[]> = ((h: X, ...args: XS) => void) extends ((...args: infer R) => void) ? R : [];
type Reverse<L extends any[], X extends any[] = []> = {
  1: X, 0: Reverse<Tail<L>, Cons<Head<L>, X>>
}[L extends [] ? 1 : 0];

type X<T extends any[]> = Reverse<Reverse<T>>;

この時以下のようにして解決します。

type X<T extends any[]> = Reverse<Reverse<T> extends infer A ? Cast<A, any[]> : never>;

ちなみに最初に書いた抑制不可能なエラーとは以下のような感じです。

type X = Reverse<[1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]>;

これは単純に再帰制限に引っかかってるので大きなサイズのデータを扱うのを諦めるか、型の再帰を減らす工夫をするしかありません。