CKTIS / JavaScript
Iteratorprotocol: next(), return(), value en done
Controleer `done`, niet `value`, om het einde van de iteratie te herkennen. Lees hoe je de eindwaarde krijgt en wanneer `for...of` de optionele methode `return()` aanroept.
Versie: ECMAScript 2024 and the current web platform; runtime support varies
Syntax
const iterator = iterable[Symbol.iterator]();
const result = iterator.next();
// result.done: completion flag; result.value: element or completion value
// When stopping early during manual iteration, call the optional method if callable:
if (typeof iterator.return === "function") {
iterator.return();
}Een synchrone iterator is een object met een methode next() die een resultaatobject (IteratorResult) teruggeeft. Een itereerbaar object heeft een methode [Symbol.iterator]() die een iterator oplevert. Alleen next() hebben maakt een object niet itereerbaar; een generatorobject vervult beide rollen. for...of haalt de iterator op en roept next() zonder argumenten aan. Wat een eventueel argument betekent, hangt af van de implementatie van de iterator.
Bij done: false is value een element, ook als het undefined is. done: true betekent dat de iteratie klaar is; value kan dan een eindwaarde bevatten die for...of niet doorgeeft aan de lusbody. Een ontbrekende done telt als false; for...of zet de eigenschap voor de test om naar een booleaanse waarde. Na afloop horen volgende aanroepen van next() nog steeds done: true te melden, maar de taal dwingt dat niet af.
De optionele methode return(value) geeft aan dat de aanroeper stopt en biedt de iterator de kans om bronnen vrij te geven. Het resultaat bevat meestal done: true en het meegegeven argument als value, maar een generator kan done: false teruggeven als die een yield in finally uitvoert. Bij voortijdig stoppen via break of een uitzondering in de lusbody roept for...of een aanwezige return() zonder argumenten aan en negeert het done en value van het resultaat. Dat gebeurt niet als de iterator normaal uitgeput raakt of als next() zelf een uitzondering opwerpt.
Handmatige aanroepen van next() sluiten de iterator niet automatisch. Stop je voortijdig, roep dan zelf return() aan als dat aanroepbaar is. for...of werpt een TypeError op als next() of de afsluitende aanroep van return() geen object teruggeeft. Als een uitzondering in de lusbody de afsluiting heeft veroorzaakt, krijgt die oorspronkelijke uitzondering voorrang.
Voorbeelden
{
function* sequence() {
try {
yield undefined;
return "end";
} finally {
console.log("cleanup");
}
}
function show(label, { done, value }) {
console.log(`${label}: done=${done}, value=${value}`);
}
const full = sequence();
show("next", full.next());
show("next", full.next());
show("next", full.next());
for (const value of sequence()) {
console.log(`loop: ${value}`);
break;
}
const manual = sequence();
manual.next();
show("return", manual.return("stopped"));
}Resultaat
next: done=false, value=undefined cleanup next: done=true, value=end next: done=true, value=undefined loop: undefined cleanup cleanup return: done=true, value=stopped
Drie afzonderlijke generatoren tonen normale uitputting met eindwaarde `end`, automatische afsluiting via `break` en een expliciete aanroep van `return("stopped")`. Elke gestarte generator schrijft `cleanup` naar de console in zijn `finally`-blok.
Gerelateerde lessen
- JavaScript · Les 8 · Gevorderd · Versie: 4