CKTIS / JavaScript
Symbol.iterator — das synchrone Iterationsprotokoll
Symbol.iterator ist das wohlbekannte Symbol, das eine Methode zur Erzeugung eines Iterators kennzeichnet. Damit können eigene Objekte mit for...of und der Array-Spread-Syntax verwendet werden. Ein Iterable stellt einen Iterator bereit, der über next() nacheinander Ergebnisse liefert.
Version: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Syntax
iterable[Symbol.iterator]()
({ [Symbol.iterator]() { return iterator; } })Symbol.iterator ist ein wohlbekanntes Symbol und keine Funktion. Es ist der Schlüssel zur Methode [Symbol.iterator]() eines iterierbaren Objekts (Iterable). Diese Methode gibt einen Iterator zurück, der unter anderem von for...of und der Array-Spread-Syntax ([...iterable]) verwendet wird. Der Zeichenketten-Schlüssel "Symbol.iterator" ist nicht derselbe Schlüssel.
Ein Iterable stellt diese Methode bereit, während ein Iterator eine next()-Methode hat. Jeder Aufruf von next() muss ein Ergebnisobjekt zurückgeben: done gibt an, ob die Iteration abgeschlossen ist, und value enthält das aktuelle Element, solange die Iteration weitergeht. Bei done: true verarbeiten Verbraucher wie for...of value nicht als Element. Eine next()-Methode allein macht ein Objekt nicht iterierbar.
Im Beispiel erzeugt jeder Aufruf von [Symbol.iterator]() einen eigenen Zähler. Deshalb liefern beide Spread-Ausdrücke 1,2,3. Ein Iterator muss nicht selbst iterierbar sein; soll er es sein, kann er [Symbol.iterator]() bereitstellen und this zurückgeben. Die Rückgabe desselben Iterators garantiert nicht, dass die Iteration neu beginnt.
Ein gewöhnliches Objekt wird nicht allein dadurch iterierbar, dass es Eigenschaften hat. Eine ungültige Implementierung, die beispielsweise aus next() eine Zahl statt eines Objekts zurückgibt, verursacht bei Verwendung des Protokolls einen TypeError. Dieser Mechanismus ist synchron; das asynchrone Protokoll verwendet das separate Symbol.asyncIterator.
Beispiele
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(','));Ergebnis
1,2,3 1,2,3
Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.