База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / JavaScript

Symbol.iterator — синхронният протокол за итериране

Symbol.iterator е добре познатият символ, който обозначава метод за създаване на итератор. Той позволява на потребителски обект да работи с for...of и разгръщане на масив. Итерируемият обект предоставя итератор, който чрез next() връща последователни резултати.

Версия: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Синтаксис

iterable[Symbol.iterator]()
({ [Symbol.iterator]() { return iterator; } })

Symbol.iterator е добре познат символ, а не функция. Той е ключът на метода [Symbol.iterator]() на итерируем обект (iterable). Този метод връща итератор, използван например от for...of и разгръщането на масив ([...iterable]). Ключът низ "Symbol.iterator" не е същият ключ.

Итерируемият обект предоставя този метод, докато итераторът има метод next(). Всяко извикване на next() трябва да връща обект с резултат: done указва дали итерацията е завършила, а value съдържа текущия елемент, докато итерацията продължава. При done: true потребители като for...of не обработват value като елемент. Самото наличие на next() не прави обекта итерируем.

В примера всяко извикване на [Symbol.iterator]() създава отделен брояч. Затова и двете разгръщания дават 1,2,3. Не е задължително итераторът сам да бъде итерируем; ако трябва да бъде, може да предостави [Symbol.iterator]() и да връща this. Връщането на същия итератор не гарантира, че итерацията ще започне отново.

Обикновеният обект не става итерируем само защото има свойства. Невалидна реализация, например такава, която връща число вместо обект от next(), причинява TypeError при използване на протокола. Този механизъм е синхронен; асинхронният протокол използва отделния символ Symbol.asyncIterator.

Примери

const numbers = {
  [Symbol.iterator]() {
    let current = 1;
    return {
      next() {
        if (current <= 3) {
          return { value: current++, done: false };
        }
        return { done: true };
      }
    };
  }
};

console.log([...numbers].join(','));
console.log([...numbers].join(','));

Резултат

1,2,3
1,2,3

Показаният код и заявеният резултат са проверени в изолирана среда по метода, записан в доказателството за проверка на тази точна версия.

Източници