Урок 142 минуты чтения
Symbol.iterator
На этой странице
Кратко
Метод [Symbol.iterator]() делает объект итерируемым. Он должен возвращать итератор: объект с методом next(), который возвращает { value, done }.
Вопрос
Что делает метод [Symbol.iterator]()?
Основная идея
Объект можно использовать в for...of, spread и других механизмах, если он iterable.
for (const value of iterable) {}
[...iterable];Iterable-объект должен иметь метод:
object[Symbol.iterator]();Итератор
Итератор - объект с методом next().
{
next() {
return { value: 1, done: false };
}
}Когда значения закончились:
{ done: true }Свой iterable-объект
const range = {
from: 1,
to: 3,
[Symbol.iterator]() {
let current = this.from;
const end = this.to;
return {
next() {
if (current <= end) {
return { value: current++, done: false };
}
return { done: true };
},
};
},
};
[...range]; // [1, 2, 3]Генератор как простой способ
Часто проще реализовать [Symbol.iterator] через генератор.
const range = {
from: 1,
to: 3,
*[Symbol.iterator]() {
for (let value = this.from; value <= this.to; value++) {
yield value;
}
},
};
[...range]; // [1, 2, 3]Встроенные iterable
[1, 2, 3]; // Array
"hello"; // String
new Set(); // Set
new Map(); // Map
document.querySelectorAll("div"); // NodeListОбычный объект не iterable:
const user = { name: "Anna" };
[...user]; // TypeErrorЧто важно помнить
- Объект итерируем, если у него есть метод
[Symbol.iterator](), возвращающий итератор сnext(). - Самый короткий способ реализации — генератор:
*[Symbol.iterator]() { yield* this.items; }. - Итерируемость дает
for...of, spread, деструктуризацию,Array.from,Promise.all. - Для асинхронной итерации —
Symbol.asyncIteratorиfor await...of.
Мини-шпаргалка
| Механизм | Что требует |
|---|---|
for...of | iterable |
spread [...x] | iterable |
Array.from(x) | iterable или array-like |
[Symbol.iterator] | метод, возвращающий iterator |
next() | возвращает { value, done } |
Документация
MDN: Протоколы перебора, learn.javascript.ru: Перебираемые объекты.
Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.