Tablice w TypeScript: typy, tablice obiektów, map i filter

Typ tablicy w TypeScript to typ elementu, a po nim []: string[] to tablica napisów, number[] tablica liczb. Zapis generyczny Array<string> to ten sam typ. Gdy tablica ma typ, każdy dodawany i każdy odczytywany element ma ten typ.

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);

Linia z @ts-expect-error to błąd kompilacji (TS2345). Tutaj jest oznaczona jako oczekiwana, żeby blok nadal się uruchamiał, a ponieważ typy znikają, 42 naprawdę trafia do tablicy w czasie działania: wynik to pokazuje.

string[] a Array<string>

Wybierz jeden styl dla całego projektu. Reguła array-type z typescript-eslint domyślnie wybiera T[].

Tablice obiektów

Opisz element aliasem typu albo interfejsem, a potem użyj Type[]. Wszystko, co odczytasz z tablicy, jest sprawdzane względem tego kształtu.

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

Literał obiektowy dodany do users musi dokładnie pasować do User: brak admin albo literówka w nazwie właściwości to błąd kompilacji.

Otypowane map, filter, reduce i find

Metody tablic są generyczne, więc ich wyniki mają typy. To, co każda metoda robi w czasie działania, opisuje strona o metodach tablic w JavaScript; TypeScript dodaje typy:

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 ]

Ostatni przykład działa, bo TypeScript (od wersji 5.5) wnioskuje, że (n) => n !== undefined jest predykatem typu, więc filter zwraca number[] zamiast (number | undefined)[]. Dla sprawdzeń, których nie potrafi wywnioskować, napisz predykat sam: filter((x): x is User => x !== null).

Tablice z więcej niż jednym typem

Unia jako typ elementu pozwala na mieszankę. Unia typów tablic już nie:

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));
}

Gdy pozycje mają stałe typy, jak para [name, age], użyj krotki: [string, number] wie, że indeks 0 to napis, a indeks 1 to liczba, czego (string | number)[] nie wie.

Tablice tylko do odczytu

readonly T[] usuwa wszystkie metody, które zmieniają tablicę. Używaj tego dla parametrów, których funkcja nie powinna zmieniać, oraz dla stałych.

// 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[]'.

Usuń linię z push, a blok wypisze 4. Zmienną tablicę number[] zawsze można przekazać tam, gdzie oczekiwane jest readonly number[], więc parametry tylko do odczytu nic nie kosztują wywołujących. Sprawdzenie działa tylko w czasie kompilacji: w czasie działania to zwykła tablica. Żeby posortować tablicę tylko do odczytu, posortuj kopię: [...values].sort().

Pułapka z includes w tablicach literałów

as const zamienia tablicę w krotkę tylko do odczytu złożoną z typów literałowych. To przydatne dla listy dozwolonych wartości, ale jej includes przyjmuje wtedy tylko te literały:

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

Opakowanie sprawdzenia w strażnika typu (value is Color) sprawia, że poszerzenie odbywa się raz, a wywołujący dostają z powrotem zawężoną wartość.

Indeksowanie i puste tablice

Odczyt arr[i] daje typ T, nawet gdy i jest poza zakresem, a wartość w czasie działania to undefined. at(i) ma typ T | undefined, a opcja kompilatora noUncheckedIndexedAccess sprawia, że zwykłe indeksowanie też zwraca 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() skompilowałoby się, a potem rzuciło TypeError w czasie działania. Gdy indeksu może brakować, wybierz at(), sprawdzenie długości albo noUncheckedIndexedAccess.