Циклы в TypeScript: for, forEach, for...of и for...in

В TypeScript те же циклы, что и в JavaScript: for, for...of, for...in, while, do...while и метод массива forEach. TypeScript добавляет к ним типы: переменная цикла for...of получает тип элемента, а ключ в for...in всегда имеет тип 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));

Для большинства циклов по массиву стоит брать for...of: он хорошо читается, поддерживает break, continue и await и не требует аннотаций.

Классический цикл for

for (init; condition; update) подходит для счёта, шага больше единицы или прохода в обратном направлении. TypeScript выводит тип счётчика из начального значения.

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

Объявляйте счётчик через let, а не var. С let каждая итерация получает свою привязку, и колбэк, созданный в цикле, видит значение своей итерации.

for...of: значения массивов, строк и Map

for...of работает с любым итерируемым объектом, и переменная цикла получает соответствующий тип. Чтобы получить ещё и индекс, перебирайте array.entries(), который выдаёт кортежи [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 выходит из цикла, а continue переходит к следующему элементу, точно как в цикле for. Подробности времени выполнения (итерируемые объекты, генераторы) на странице JavaScript for...of и for...in.

forEach: без break и без await

forEach вызывает функцию для каждого элемента и возвращает undefined. Параметры колбэка получают типы из массива, так что аннотации не нужны. Двух вещей он не умеет:

• Остановиться раньше. break внутри колбэка даёт ошибку компиляции TS1107, Jump target cannot cross function boundary. return завершает только текущий вызов, то есть работает как continue.
• Дождаться асинхронной работы. forEach игнорирует промис, который возвращает 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

Асинхронную ловушку легко пропустить, потому что код компилируется без предупреждений:

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

Колбэки forEach завершаются в порядке таймеров (10, 20, 30), когда цикл уже пошёл дальше. Версия с for...of выполняет их по очереди. Для параллельной работы, которую всё равно нужно дождаться, используйте await Promise.all(items.map(async (item) => { ... })).

for...in: ключи это строки

for...in перебирает имена перечисляемых свойств объекта. Тип ключа всегда string, даже для массивов, где ключами служат индексы в виде строк. Из-за этого индексировать им типизированный объект неудобно:

// 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 намеренно типизирует ключ как string: во время выполнения у объекта может быть больше свойств, чем перечислено в его типе (структурная типизация допускает лишние), а for...in проходит и по унаследованным перечисляемым свойствам. Поэтому он не может обещать, что ключ это "name" | "age". Способы исправить описаны в следующем разделе. Для массивов for...in не используйте вообще.

Перебор ключей и значений объекта

Object.entries даёт пары [key, value] и считается обычным способом перебрать объект. Object.keys возвращает string[] по той же причине, что и for...in, поэтому, если вы знаете, что лишних ключей у объекта нет, укажите тип ключа утверждением.

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

Для данных, ключи которых заранее неизвестны, типизируйте объект как Record<string, number> или используйте Map; оба варианта описаны на странице словарь.

while и do...while

while проверяет условие перед каждым проходом; do...while сначала один раз выполняет тело, а потом проверяет. Они подходят для циклов, которые не обходят коллекцию, например для чтения до выполнения условия. Сужение типов внутри них работает: после проверки !== undefined в условии переменная в теле сужена.

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

Метки, break и continue во вложенных циклах

Обычный 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 ]

Какой цикл выбрать