CKTIS / JavaScript
Symbol.iterator — protokół iteracji synchronicznej
Symbol.iterator to standardowy symbol wskazujący metodę tworzącą iterator. Dzięki niej własny obiekt może współpracować z for...of i rozwijaniem do tablicy. Obiekt iterowalny udostępnia iterator, a iterator dostarcza kolejne wyniki przez next().
Wersja: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Składnia
iterable[Symbol.iterator]()
({ [Symbol.iterator]() { return iterator; } })Symbol.iterator jest standardowym symbolem, a nie funkcją. Służy jako klucz metody [Symbol.iterator]() obiektu iterowalnego (iterable). Metoda zwraca iterator używany między innymi przez for...of oraz rozwijanie do tablicy ([...iterable]). Klucz tekstowy "Symbol.iterator" nie jest tym samym kluczem.
Obiekt iterowalny udostępnia tę metodę, natomiast iterator ma metodę next(). Każde wywołanie next() musi zwrócić obiekt wyniku: done określa zakończenie, a value zawiera bieżący element, gdy iteracja trwa. Przy done: true odbiorcy tacy jak for...of nie przetwarzają value jako elementu. Samo posiadanie next() nie czyni obiektu iterowalnym.
W przykładzie każde wywołanie [Symbol.iterator]() tworzy osobny licznik. Dlatego oba rozwinięcia dają 1,2,3. Iterator nie musi sam być iterowalny; jeśli ma nim być, może udostępniać [Symbol.iterator]() zwracające this. Zwracanie tego samego iteratora nie gwarantuje ponownego rozpoczęcia iteracji.
Zwykły obiekt nie staje się iterowalny tylko dlatego, że ma właściwości. Niepoprawna implementacja, na przykład zwracająca z next() liczbę zamiast obiektu, powoduje TypeError podczas użycia protokołu. Jest to mechanizm synchroniczny; protokół asynchroniczny używa osobnego Symbol.asyncIterator.
Przykłady
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(','));Wynik
1,2,3 1,2,3
Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.