CKTIS / JavaScript
Symbol.iterator — het synchrone iteratieprotocol
Symbol.iterator is het bekende symbool dat een methode aanduidt die een iterator maakt. Hiermee kan een aangepast object werken met for...of en array-spread. Een iterable levert een iterator, die via next() achtereenvolgende resultaten levert.
Versie: 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 is een bekend symbool, geen functie. Het is de sleutel van de methode [Symbol.iterator]() van een itereerbaar object (iterable). Deze methode retourneert een iterator die onder meer wordt gebruikt door for...of en array-spread ([...iterable]). De tekenreekssleutel "Symbol.iterator" is niet dezelfde sleutel.
Een iterable biedt deze methode aan, terwijl een iterator een next()-methode heeft. Elke aanroep van next() moet een resultaatobject retourneren: done geeft aan of de iteratie is voltooid, en value bevat het huidige element zolang de iteratie doorgaat. Bij done: true verwerken gebruikers zoals for...of value niet als een element. Alleen een next()-methode hebben maakt een object niet itereerbaar.
In het voorbeeld maakt elke aanroep van [Symbol.iterator]() een afzonderlijke teller. Daarom leveren beide spread-bewerkingen 1,2,3 op. Een iterator hoeft zelf niet itereerbaar te zijn; om dat wel te zijn, kan hij [Symbol.iterator]() aanbieden en this retourneren. Dezelfde iterator retourneren garandeert niet dat de iteratie opnieuw begint.
Een gewoon object wordt niet itereerbaar alleen doordat het eigenschappen heeft. Een ongeldige implementatie, bijvoorbeeld een implementatie die vanuit next() een getal in plaats van een object retourneert, veroorzaakt een TypeError wanneer het protocol wordt gebruikt. Dit mechanisme is synchroon; het asynchrone protocol gebruikt het afzonderlijke Symbol.asyncIterator.
Voorbeelden
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(','));Resultaat
1,2,3 1,2,3
De getoonde code en het opgegeven resultaat zijn in een geïsoleerde omgeving geverifieerd met de methode die in het verificatiebewijs voor exact deze versie is vastgelegd.