TypeScriptの配列: 型の書き方、オブジェクトの配列、map・filter

TypeScriptの配列の型は、要素の型のあとに [] を付けて書きます。string[] は文字列の配列、number[] は数値の配列です。ジェネリックの書き方 Array<string> も同じ型です。配列に型を付けると、追加する要素も読み出す要素もすべてその型になります。

const names: string[] = ["Ada", "Grace"];
const scores: Array<number> = [90, 85, 72]; // same as number[]

names.push("Alan");
// @ts-expect-error: Argument of type 'number' is not assignable to parameter of type 'string'.
names.push(42);

const first: string = names[0];
const total = scores.reduce((sum, s) => sum + s, 0); // number

console.log(names, first, total);

@ts-expect-error の行はコンパイルエラー（TS2345）です。ここでは想定済みとしているのでブロックは実行され、型は消去されるので、実行時には 42 が本当に追加されます。出力にもそれが表れています。

string[] vs Array<string>

コードベースではどちらかひとつのスタイルに統一しましょう。typescript-eslint の array-type ルールのデフォルトは T[] です。

オブジェクトの配列

要素を型エイリアスかインターフェースで表し、Type[] を使います。配列から読み出すものはすべてその形でチェックされます。

type User = { id: number; name: string; admin: boolean };

const users: User[] = [
    { id: 1, name: "Ada", admin: true },
    { id: 2, name: "Grace", admin: false },
    { id: 3, name: "Alan", admin: false },
];

users.push({ id: 4, name: "Linus", admin: false });

const admins = users.filter((u) => u.admin);       // User[]
const names = users.map((u) => u.name);            // string[]
const byId = users.find((u) => u.id === 2);        // User | undefined

console.log(admins.length, names);
console.log(byId?.name ?? "not found"); // Grace

users に追加するオブジェクトリテラルは User に正確に一致しなければなりません。admin がなかったり、プロパティ名のつづりを間違えたりするとコンパイルエラーになります。

型付きの map、filter、reduce、find

配列のメソッドはジェネリックなので、結果にも型が付きます。各メソッドが実行時に何をするかはJavaScriptの配列メソッドのページで説明しています。TypeScriptが加えるのは型です:

const prices = [4.5, 12, 8.25];

const labels = prices.map((p) => `$${p.toFixed(2)}`); // string[]
console.log(labels); // [ '$4.50', '$12.00', '$8.25' ]

const expensive = prices.find((p) => p > 100); // number | undefined
console.log(expensive ?? "none"); // none

// reduce's result type comes from the initial value,
// or from a type argument when the initial value is just {}
const byInitial = ["apple", "avocado", "banana"].reduce<Record<string, string[]>>(
    (acc, word) => {
        (acc[word[0]] ??= []).push(word);
        return acc;
    },
    {},
);
console.log(byInitial); // { a: [ 'apple', 'avocado' ], b: [ 'banana' ] }

// filter narrows when the callback is a type check
const raw = [1, undefined, 3, undefined];
const defined = raw.filter((n) => n !== undefined); // number[]
console.log(defined); // [ 1, 3 ]

最後の例がうまくいくのは、TypeScript（5.5 以降）が (n) => n !== undefined を型述語として推論し、filter が (number | undefined)[] ではなく number[] を返すからです。推論できないチェックでは、filter((x): x is User => x !== null) のように型述語を自分で書きます。

複数の型を持つ配列

要素の型をユニオンにすると型を混在させられます。配列の型のユニオンでは混在できません:

const mixed: (string | number)[] = [1, "two", 3]; // each element: string or number

let ids: string[] | number[] = [1, 2, 3]; // all numbers...
ids = ["a", "b"];                          // ...or all strings

// @ts-expect-error: (string | number)[] is not assignable to string[] | number[]
ids = [1, "b"];

for (const item of mixed) {
    // narrow each element before using type-specific methods
    console.log(typeof item === "string" ? item.toUpperCase() : item.toFixed(1));
}

[name, age] のペアのように位置ごとに型が決まっている場合はタプルを使います。[string, number] はインデックス0が文字列でインデックス1が数値だとわかっていますが、(string | number)[] はそれを知りません。

readonly 配列

readonly T[] は配列を変更するメソッドをすべて取り除きます。関数が変更すべきでないパラメーターや定数に使います。

// This does not compile: readonly arrays have no push.
function average(values: readonly number[]): number {
    values.push(0);
    return values.reduce((a, b) => a + b, 0) / values.length;
}

console.log(average([2, 4, 6]));

index.ts(3,12): error TS2339: Property 'push' does not exist on type 'readonly number[]'.

push の行を消せばブロックは 4 を出力します。readonly number[] が期待される場所には、変更可能な number[] をいつでも渡せるので、readonly のパラメーターは呼び出し側に何の負担もかけません。このチェックはコンパイル時だけで、実行時には普通の配列です。readonly 配列を並べ替えるには、コピーを並べ替えます: [...values].sort()。

リテラルの配列での includes の落とし穴

as const は配列をリテラル型の readonly タプルにします。許可された値の一覧には便利ですが、その includes はそのリテラルしか受け付けなくなります:

const COLORS = ["red", "green", "blue"] as const;
type Color = (typeof COLORS)[number]; // "red" | "green" | "blue"

function isColor(value: string): value is Color {
    // COLORS.includes(value) is error TS2345: 'string' is not assignable
    // to '"blue" | "green" | "red"'. Widen the array for the check:
    return (COLORS as readonly string[]).includes(value);
}

const input: string = "green";
if (isColor(input)) {
    const c: Color = input; // narrowed to Color
    console.log("valid color:", c);
}
console.log(isColor("purple")); // false

チェックを型ガード（value is Color）で包めば、配列を広げるのは1か所で済み、呼び出し側には絞り込まれた値が返ります。

インデックスアクセスと空の配列

arr[i] を読むと、i が範囲外で実行時の値が undefined でも型は T です。at(i) の型は T | undefined で、コンパイラーオプション noUncheckedIndexedAccess を有効にすると普通のインデックスアクセスも T | undefined を返すようになります。

const queue: string[] = []; // annotate empty arrays

const head = queue[0];     // type string, value undefined
const last = queue.at(-1); // type string | undefined

console.log(head, last);            // undefined undefined
console.log(last?.toUpperCase());   // undefined, safely

queue[0].toUpperCase() はコンパイルが通り、実行時に TypeError を投げます。インデックスが存在しないかもしれない場合は、at()、長さのチェック、noUncheckedIndexedAccess のいずれかを使いましょう。