［型パズル］TypeScript で連番の配列に詳しい型を付ける
目標
以下の返り値型の rangeArray 関数を実装すること。
function rangeArray<S extends number, E extends number>(
start: S,
end: E,
step: number = 1
): /* TODO */;
const result: readonly [1, 2, 3, 4] = rangeArray(1, 5); // ok
console.log(result); // [1, 2, 3, 4]
start と end が（型計算が重くならない）十分小さな非負整数で step = 1 が満たされる場合には、返り値に number[] ではなく [1, 2, 3, 4] のようなより詳しい型を付ける、というのが今回やりたいことです。
完成品
解説
以降は実装の解説です。
関数本体の実装
型は後で付けるとして本体をまず実装します。
実装方法は色々あり得ますが、以下のような実装をしておきます。
function rangeArray(start: number, end: number, step: number = 1): number[] {
return Array.from(range(start, end, step));
}
function* range(
start: number,
end: number,
step: number = 1,
): Generator<number, void, unknown> {
for (let i: number = start; step > 0 ? i < end : i > end; i += step) {
yield i;
}
}
ちなみに今回は必要有りませんが、この range という generator 関数は以下の使い方も想定しています。
for (const i of range(1, 5)) {
console.log(i);
}
// 1
// 2
// 3
// 4
型の実装
結果配列が大きすぎる場合、型計算が重くなったりそもそも再帰制限にひっかかって計算できなかったりするので、 start と end が十分小さい場合のみ型を詳細化することにします。以下のように関数をオーバーロードして、引数の型に応じて return type を詳細化した型 RangeList<S, E> にするか number[] にするかが決まるようにします。
type Uint8 = Index<256>; // 0 | 1 | 2 | ... | 255
function rangeArray<S extends Uint8, E extends Uint8>(
start: S,
end: E,
step?: 1,
): RangeList<S, E>;
function rangeArray(start: number, end: number, step?: number): number[];
Uint8 型はべた書きでも良いかもしれませんが、 Index という型ユーティリティを実装すれば Index<256> として実装できます。詳しくはTypeScript 型ユーティリティ集を参照してください。
start: S や end: E には 1 個の非負整数ではなく Uint8 の部分型の union 型（例： 1 | 2 | 3）が渡される可能性もありますが、その場合には S の最小値から E の最大値までの整数の union を要素とする長さ不定の配列型を返り値とするという要件もここで追加しておきます[1]。
const s = 2 as 1 | 2 | 3;
const e = 6 as 5 | 6 | 7;
const result2: readonly (1 | 2 | 3 | 4 | 5 | 6)[] = rangeArray(s, e);
console.log(result2); // [2, 3, 4, 5]
これは以下のように引数にユーザー定義の数値の union 型の変数を渡す場合にも対応するためです。
type MonthEnum = Exclude<Index<13>, 0>; // 1 | 2 | ... | 12
type DateEnum = Exclude<Index<32>, 0>; // 1 | 2 | ... | 31
const getAllDatesOfMonth = (year: number, month: MonthEnum): DateEnum[] =>
rangeArray(
1,
(getLastDateNumberOfMonth(year, month) + 1) as 29 | 30 | 31 | 32,
) satisfies DateEnum[];
const getLastDateNumberOfMonth = (
year: number,
month: MonthEnum,
): 28 | 29 | 30 | 31 => new Date(year, month, 0).getDate() as 28 | 29 | 30 | 31;
console.log(getAllDatesOfMonth(2024, 2));
// [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29]
次節以降で RangeList<S, E> 型を実装していきます。
RangeList<S, E>
RangeList<S, E> の本体は以下の実装になります。
type RangeList<S extends Uint8, E extends Uint8> =
// S, E のいずれかが 2 要素以上の union の場合
BoolOr<IsUnion<S>, IsUnion<E>> extends true
? Exclude<LT[E], LT[Min<S>]>[] // union に対して Seq で型計算すると、結果が正しくならないので、その回避のため
: ListSkip<S, Seq<E>>;
ユニットテスト
expectType<RangeList<1, 5>, readonly [1, 2, 3, 4]>('=');
expectType<RangeList<1, 2>, readonly [1]>('=');
expectType<RangeList<1, 1>, readonly []>('=');
expectType<RangeList<1, 1 | 3>, readonly (1 | 2)[]>('=');
expectType<RangeList<1 | 3, 3 | 5>, readonly (1 | 2 | 3 | 4)[]>('=');
expectType<RangeList<1 | 2 | 3, 5 | 6 | 7>, readonly (1 | 2 | 3 | 4 | 5 | 6)[]>(
'=',
);
expectType<RangeList<5, 1>, readonly []>('=');
expectType はここでは expect<A, B>("=") が A と B は等しい型であることを確認する型レベルの assert 文を表しています。型ユニットテスト用ユーティリティ expectType の詳細についてはTypeScript 型ユーティリティ集を参照してください。
ListSkip<S, Seq<E>> の部分は S と E がちょうど 1 要素の非負整数（0 以上 255 以下）の場合の型です。
ListSkip<N, T> はタプル型 T の先頭 N 要素を除いた型を返す型です（例：ListSkip<2, [1, 2, 3, 4, 5]> = [3, 4, 5]）。
Seq<N> は整数 N までの連番配列を返す型です（例： Seq<5> = [0, 1, 2, 3, 4]。
これらを組み合わせると ListSkip<S, Seq<E>> とすることで S 以上 E 未満の整数の連番配列を作ることができます（例： RangeList<1, 5> = [1, 2, 3, 4]）。よって、 ListSkip と Seq を作ることができればここは解決します。
次に S または E が union 型の場合の判定ですが、これは BoolOr と IsUnion という型ユーティリティを実装することで実現できます。実装は TypeScript 型ユーティリティ集を参照してください。
そしてそのときの型は、 union 型 S の中の最小値 L から union 型 E の中の最大値 - 1 = U までの union 型を要素とする配列 (L | (L + 1) | ... | (U - 1) | U)[] とします。これは後述の LT という配列を作ることで Exclude<LT[E], LT[Min<S>]>[] として実装することができます。
LT[U] は U の最大値未満のすべての非負整数を含む union 型を返すようにします（例： LT[4 | 5 | 6] = 0 | 1 | 2 | 3 | 4 | 5）。 Min は非負整数の union 型 U を受け取り、最小値を返す型です（例： Min<3 | 4 | 5> = 3）。Min の実装についてはTypeScript の型ユーティリティ Min, Max の実装という記事で解説しているのでそちらを参照してください。あとは LT を実装できれば OK です。
ListSkip の実装
以下の実装になります。
type ListSkip<N extends number, T extends readonly unknown[]> =
ListSkipImpl<N, T, []>;
type ListSkipImpl<
N extends number,
T extends readonly unknown[],
R extends readonly unknown[],
> = T extends readonly []
? T
: R['length'] extends N
? T
: ListSkipImpl<N, Tail<T>, [Head<T>, ...R]>;
Head<T> は T の先頭要素を取り出す型です。これは infer を使って以下で実装できます。
type Head<T extends readonly unknown[], D = never> = T extends readonly [
infer X,
...(readonly unknown[]),
]
? X
: D;
Tail<T> は T の先頭要素を除いた残りの配列を返す型です。以下で実装できます。
type Tail<A extends readonly unknown[]> = A extends readonly []
? readonly []
: A extends readonly [unknown, ...infer R]
? R
: A;
ListSkipImpl<N, T, R> は、T を先頭要素 H と残りに分け、 T = Tail<T>, R = [Head<T>, ...R] と更新して再帰呼び出しし、 R の長さが N に到達した時点で R['length'] extends N という条件が満たされるので T が返される、という動作になっています。
ListSkip<2, [1, 2, 3, 4, 5]>
-> ListSkipImpl<2, [1, 2, 3, 4, 5], []>
-> ListSkipImpl<2, [2, 3, 4, 5], [1]>
-> ListSkipImpl<2, [3, 4, 5], [2, 1]>
-> [3, 4, 5]
Seq の実装
type Seq<N extends number> = SeqImpl<N, MakeTuple<unknown, N>>;
type SeqImpl<N extends number, T extends readonly unknown[]> = {
[i in keyof T]: i extends `${number}` ? ToNumber<i> : never;
};
type ToNumber<S extends `${number}`> = S extends `${infer N extends number}`
? N
: never;
MakeTuple<E, N> はN 要素の E からなるタプルを返す型で、TypeScript 型ユーティリティ集で実装方法を解説しています。
Seq は、長さ N の適当な配列を作り、 keyof でその key を取り出すことで連番配列を作っています。このとき keyof の結果は文字列リテラル型になってしまうのでこれを数値型にするために ToNumber を使っています。
LT の実装
type LT = {
[N in Uint8]: Index<N>;
};
// {
// 0: never;
// 1: 0;
// 2: 0 | 1;
// 3: 0 | 1 | 2;
// 4: 0 | 1 | 2 | 3;
// 5: 0 | 1 | 2 | 3 | 4;
// 6: 0 | 1 | 2 | 3 | 4 | 5;
// ...
// }
で実装できます。
Index の実装はTypeScript 型ユーティリティ集を参照してください。
-
一応
S = 1 | 2,E = 3 | 4なら[1, 2] | [1, 2, 3] | [2] | [2, 3]という感じで全パターンの union 型を返すように定義できる可能性はありますが、|S| \times |E|
Discussion