Loops em TypeScript: for, forEach, for...of e for...in

O TypeScript tem os mesmos loops do JavaScript: for, for...of, for...in, while, do...while e o método de array forEach. O que o TypeScript acrescenta são os tipos: a variável de um for...of tem o tipo do elemento, e uma chave de for...in é sempre uma 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));

Na maioria dos loops sobre arrays, for...of é a escolha certa: é fácil de ler, aceita break, continue e await e não precisa de anotações.

O for clássico

for (init; condition; update) é o loop para contar, avançar de mais de um em um ou percorrer de trás para frente. O TypeScript infere o contador a partir do valor inicial.

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

Declare o contador com let, não com var. Com let, cada iteração tem seu próprio binding, então um callback criado dentro do loop enxerga o valor daquela iteração.

for...of: valores de arrays, strings e maps

for...of funciona com qualquer iterável, e a variável do loop recebe o tipo correspondente. Para ter também o índice, percorra array.entries(), que gera tuplas [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 sai do loop e continue pula para o próximo item, exatamente como em um for. Os detalhes de tempo de execução (iteráveis, generators) estão na página de for...of e for...in do JavaScript.

forEach: sem break, sem await

forEach chama uma função para cada elemento e retorna undefined. Os parâmetros do callback são tipados a partir do array, então não precisam de anotação. Duas coisas que ele não faz:

• Parar antes. break dentro do callback é o erro de compilação TS1107, Jump target cannot cross function boundary. Um return só encerra a chamada atual, então funciona como continue.
• Esperar trabalho assíncrono. forEach ignora a promise que um callback async retorna.

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

A armadilha do async passa despercebida com facilidade, porque compila sem nenhum aviso:

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

Os callbacks do forEach terminam na ordem dos timers (10, 20, 30), depois que o loop já seguiu em frente. A versão com for...of os executa em sequência. Para trabalho em paralelo que você ainda precisa esperar, use await Promise.all(items.map(async (item) => { ... })).

for...in: as chaves são strings

for...in percorre os nomes das propriedades enumeráveis de um objeto. O tipo da chave é sempre string, até em arrays, em que as chaves são os índices como strings. Isso atrapalha na hora de indexar um objeto tipado:

// 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; }'.

O TypeScript tipa a chave como string de propósito: em tempo de execução um objeto pode ter mais propriedades do que o tipo lista (a tipagem estrutural permite propriedades extras), e for...in também percorre propriedades enumeráveis herdadas. Então ele não tem como garantir que a chave é "name" | "age". As correções estão na próxima seção. Evite for...in em arrays.

Percorrendo as chaves e os valores de um objeto

Object.entries dá pares [key, value] e é a forma usual de percorrer um objeto. Object.keys retorna string[] pelo mesmo motivo que for...in, então, quando você sabe que o objeto não tem chaves extras, faça uma assertion do tipo da chave.

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

Para dados cujas chaves não são conhecidas de antemão, tipe o objeto como Record<string, number> ou use um Map; os dois estão na página de dicionário.

while e do...while

while verifica a condição antes de cada passada; do...while executa o corpo uma vez antes de verificar. Eles servem para loops que não percorrem uma coleção, como ler até uma condição ser satisfeita. O narrowing funciona dentro deles: depois de uma verificação !== undefined na condição, a variável fica estreitada no corpo.

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

Labels, break e continue em loops aninhados

Um break simples sai só do loop mais interno. Para sair de um loop externo, dê um label a ele e use o nome do label:

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 ]

Qual loop usar