TypeScript Array: Typen, Arrays von Objekten, map und filter

Ein Array-Typ in TypeScript ist der Elementtyp gefolgt von []: string[] ist ein Array von Strings, number[] ein Array von Zahlen. Die generische Schreibweise Array<string> ist derselbe Typ. Sobald ein Array typisiert ist, hat jedes Element, das du hinzufügst oder ausliest, diesen 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);

Die Zeile mit @ts-expect-error ist ein Compilerfehler (TS2345). Hier ist er als erwartet markiert, damit der Block trotzdem läuft, und da Typen entfernt werden, wird die 42 zur Laufzeit wirklich eingefügt: Die Ausgabe zeigt sie.

string[] vs Array<string>

Entscheide dich in einer Codebasis für einen Stil. Die Regel array-type von typescript-eslint verwendet standardmäßig T[].

Arrays von Objekten

Beschreibe das Element mit einem Typalias oder Interface und nutze dann Type[]. Alles, was aus dem Array gelesen wird, wird gegen diese Form geprüft.

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

Ein Objektliteral, das in users eingefügt wird, muss genau zu User passen: Ein fehlendes admin oder eine falsch geschriebene Eigenschaft ist ein Compilerfehler.

Typisiertes map, filter, reduce und find

Die Array-Methoden sind generisch, daher tragen ihre Ergebnisse Typen. Was jede Methode zur Laufzeit tut, steht auf der JavaScript-Seite zu Array-Methoden; die Typen sind das, was TypeScript hinzufügt:

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 ]

Das letzte Beispiel funktioniert, weil TypeScript (seit 5.5) erkennt, dass (n) => n !== undefined ein Type Predicate ist, sodass filter number[] statt (number | undefined)[] zurückgibt. Für Prüfungen, die es nicht ableiten kann, schreibst du das Predicate selbst: filter((x): x is User => x !== null).

Arrays mit mehr als einem Typ

Ein Union-Elementtyp erlaubt eine Mischung. Eine Union von Array-Typen nicht:

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

Haben Positionen feste Typen, etwa ein Paar [name, age], nimm stattdessen ein Tupel: [string, number] weiß, dass Index 0 ein String und Index 1 eine Zahl ist, (string | number)[] weiß das nicht.

Readonly Arrays

readonly T[] entfernt jede Methode, die das Array verändert. Nutze es für Parameter, die eine Funktion nicht ändern soll, und für Konstanten.

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

Lösche die Zeile mit push, und der Block gibt 4 aus. Ein veränderbares number[] kann immer dort übergeben werden, wo readonly number[] erwartet wird, readonly Parameter kosten Aufrufer also nichts. Die Prüfung gilt nur beim Kompilieren: Zur Laufzeit ist es ein gewöhnliches Array. Um ein readonly Array zu sortieren, sortierst du eine Kopie: [...values].sort().

Die includes-Falle bei Literal-Arrays

as const macht aus einem Array ein readonly Tupel aus Literaltypen. Das ist nützlich für eine Liste erlaubter Werte, aber includes akzeptiert dann nur diese Literale:

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

Steckt die Prüfung in einem Type Guard (value is Color), passiert die Erweiterung nur einmal, und Aufrufer bekommen einen eingeengten Wert zurück.

Indexzugriff und leere Arrays

arr[i] zu lesen ergibt den Typ T, selbst wenn i außerhalb des Bereichs liegt und der Wert zur Laufzeit undefined ist. at(i) ist als T | undefined typisiert, und die Compileroption noUncheckedIndexedAccess lässt auch den einfachen Indexzugriff T | undefined zurückgeben.

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() würde kompilieren und dann zur Laufzeit einen TypeError werfen. Nimm at(), eine Längenprüfung oder noUncheckedIndexedAccess, wenn ein Index fehlen kann.