Pętle w TypeScript: for, forEach, for...of i for...in

TypeScript ma te same pętle co JavaScript: for, for...of, for...in, while, do...while i metodę tablic forEach. TypeScript dodaje do nich typy: zmienna pętli for...of ma typ elementów, a klucz w for...in zawsze jest typu string.

const scores: number[] = [90, 72, 85];

// Classic for loop: i is number
for (let i = 0; i < scores.length; i++) {
    console.log(`#${i + 1}: ${scores[i]}`);
}

// for...of: score is number
for (const score of scores) {
    console.log(score >= 80 ? "pass" : "fail");
}

// forEach: callback gets (value, index, array)
scores.forEach((score, index) => console.log(index, score));

W większości pętli po tablicach warto sięgać po for...of: dobrze się czyta, obsługuje break, continue i await i nie wymaga adnotacji.

Klasyczna pętla for

for (init; condition; update) to pętla do liczenia, przechodzenia z krokiem większym niż jeden albo od końca. TypeScript wnioskuje typ licznika z jego wartości początkowej.

// Every second index
for (let i = 0; i < 10; i += 2) {
    step(i);
}

// Backwards over an array
const letters = ["a", "b", "c"];
for (let i = letters.length - 1; i >= 0; i--) {
    console.log(letters[i]);
}

function step(n: number) {
    console.log("step", n);
}

Deklaruj licznik przez let, a nie var. Przy let każda iteracja dostaje własne wiązanie, więc callback utworzony w pętli widzi wartość z tej iteracji.

for...of: wartości tablic, stringów i map

for...of działa ze wszystkim, co jest iterowalne, a zmienna pętli dostaje odpowiedni typ. Żeby mieć też indeks, iteruj po array.entries(), które zwraca krotki [index, value].

type Task = { title: string; done: boolean };
const tasks: Task[] = [
    { title: "write docs", done: true },
    { title: "fix bug", done: false },
];

for (const task of tasks) {              // task: Task
    console.log(task.title, task.done ? "done" : "todo");
}

for (const [i, task] of tasks.entries()) { // i: number, task: Task
    console.log(i, task.title);
}

for (const ch of "hey") console.log(ch);   // ch: string

const ages = new Map([["ada", 36], ["alan", 41]]);
for (const [name, age] of ages) {          // name: string, age: number
    console.log(`${name} is ${age}`);
}

break wychodzi z pętli, a continue przeskakuje do następnego elementu, dokładnie jak w pętli for. Szczegóły działania (obiekty iterowalne, generatory) są na stronie JavaScriptu o for...of i for...in.

forEach: bez break i bez await

forEach wywołuje funkcję dla każdego elementu i zwraca undefined. Parametry callbacku są typowane na podstawie tablicy, więc adnotacje nie są potrzebne. Dwóch rzeczy nie potrafi:

• Zakończyć wcześniej. break w callbacku to błąd kompilacji TS1107, Jump target cannot cross function boundary. return kończy tylko bieżące wywołanie, więc działa jak continue.
• Czekać na pracę asynchroniczną. forEach ignoruje promise zwracane przez callback async.

const nums = [1, 2, 3, 4, 5];

// return skips, it does not stop
nums.forEach((n) => {
    if (n % 2 === 0) return;
    console.log("odd", n);
});

// To stop early, use for...of with break, or some/find
for (const n of nums) {
    if (n > 2) break;
    console.log("small", n);
}
const firstBig = nums.find((n) => n > 3); // number | undefined
console.log(firstBig); // 4

Pułapkę z async łatwo przeoczyć, bo kod kompiluje się bez ostrzeżenia:

const wait = (ms: number) => new Promise<void>((resolve) => setTimeout(resolve, ms));

async function main() {
    // forEach starts all three and does not wait
    [30, 10, 20].forEach(async (ms) => {
        await wait(ms);
        console.log("forEach finished", ms);
    });
    console.log("after forEach"); // printed first

    await wait(50);

    // for...of waits for each await in turn
    for (const ms of [30, 10, 20]) {
        await wait(ms);
        console.log("for...of finished", ms);
    }
    console.log("after for...of"); // printed last
}

main();

Callbacki forEach kończą się w kolejności timerów (10, 20, 30), gdy pętla już poszła dalej. Wersja z for...of wykonuje je po kolei. Do pracy równoległej, na którą i tak chcesz poczekać, użyj await Promise.all(items.map(async (item) => { ... })).

for...in: klucze są stringami

for...in przechodzi po nazwach wyliczalnych właściwości obiektu. Klucz zawsze ma typ string, nawet w tablicach, gdzie kluczami są indeksy w postaci stringów. Przez to niewygodnie się nim indeksuje otypowany obiekt:

// This does not compile: key is string, not "name" | "age".
const user = { name: "Ada", age: 36 };

for (const key in user) {
    console.log(key, user[key]);
}

index.ts(5,22): error TS7053: Element implicitly has an 'any' type because expression of type 'string' can't be used to index type '{ name: string; age: number; }'.
  No index signature with a parameter of type 'string' was found on type '{ name: string; age: number; }'.

TypeScript celowo typuje klucz jako string: w czasie działania obiekt może mieć więcej właściwości, niż wymienia jego typ (typowanie strukturalne dopuszcza dodatkowe), a for...in przechodzi też po odziedziczonych wyliczalnych właściwościach. Nie może więc obiecać, że klucz to "name" | "age". Rozwiązania są w następnej sekcji. Na tablicach w ogóle unikaj for...in.

Iterowanie po kluczach i wartościach obiektu

Object.entries daje pary [key, value] i jest typowym sposobem na iterowanie po obiekcie. Object.keys zwraca string[] z tego samego powodu co for...in, więc gdy wiesz, że obiekt nie ma dodatkowych kluczy, użyj asercji typu klucza.

const prices = { tea: 2.5, coffee: 3.2, juice: 4 };

// Keys and values: key is string, value is number
for (const [item, price] of Object.entries(prices)) {
    console.log(`${item}: $${price.toFixed(2)}`);
}

// Typed keys: assert once, then index safely
type Item = keyof typeof prices; // "tea" | "coffee" | "juice"
for (const item of Object.keys(prices) as Item[]) {
    console.log(item, prices[item] * 2);
}

// Just the values
const total = Object.values(prices).reduce((sum, p) => sum + p, 0);
console.log(total); // 9.7

Dla danych, których klucze nie są znane z góry, otypuj obiekt jako Record<string, number> albo użyj Map; oba sposoby opisuje strona o słownikach.

while i do...while

while sprawdza warunek przed każdym przebiegiem; do...while wykonuje ciało raz przed sprawdzeniem. Pasują do pętli, które nie przechodzą po kolekcji, na przykład do czytania, dopóki warunek nie zostanie spełniony. Zawężanie działa w ich wnętrzu: po sprawdzeniu !== undefined w warunku zmienna jest zawężona w ciele pętli.

const queue: string[] = ["a", "b", "c"];

let next: string | undefined;
while ((next = queue.shift()) !== undefined) {
    console.log("processing", next.toUpperCase()); // next: string here
}

let attempts = 0;
do {
    attempts++;
    console.log("attempt", attempts);
} while (attempts < 2);

Etykiety, break i continue w zagnieżdżonych pętlach

Zwykłe break wychodzi tylko z najbardziej wewnętrznej pętli. Żeby wyjść z pętli zewnętrznej, nadaj jej etykietę i podaj ją po break:

const grid: number[][] = [
    [1, 2, 3],
    [4, 5, 6],
    [7, 8, 9],
];

let found: [number, number] | null = null;

outer: for (let row = 0; row < grid.length; row++) {
    for (let col = 0; col < grid[row].length; col++) {
        if (grid[row][col] === 5) {
            found = [row, col];
            break outer; // leaves both loops
        }
    }
}
console.log(found); // [ 1, 1 ]

Której pętli użyć