Массивы в 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[] и Array<string>

Выберите один стиль для всей кодовой базы. Правило array-type в typescript-eslint по умолчанию требует 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[], а не (number | undefined)[]. Для проверок, которые он вывести не может, напишите предикат сами: 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. Изменяемый number[] всегда можно передать туда, где ожидается readonly 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), расширение происходит один раз, а вызывающий код получает обратно суженное значение.

Индексация и пустые массивы

Чтение arr[i] даёт тип T, даже если i вне диапазона и значение во время выполнения равно undefined. 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.