CKTIS / JavaScript
Symbol.asyncIterator — het asynchrone iteratieprotocol
Symbol.asyncIterator is een ingebouwd symbool dat de methode aanduidt waarmee een object zijn asynchrone iterator beschikbaar stelt. Zo kan for await...of opeenvolgende waarden ophalen terwijl het op de resultaten van next() wacht.
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
Symbol.asyncIterator
object[Symbol.asyncIterator]()
async *[Symbol.asyncIterator]() { /* yield values */ }Symbol.asyncIterator is een bekend symbool dat als eigenschapssleutel wordt gebruikt, niet een functie die je rechtstreeks aanroept. De methode object[Symbol.asyncIterator]() retourneert een asynchrone iterator: het iteratorobject zelf, niet een promise voor een iterator. Dit mechanisme maakt sinds ECMAScript 2018 (ES2018) deel uit van ECMAScript; het is geen Web-API.
Een asynchroon itereerbaar object stelt deze methode beschikbaar, terwijl een asynchrone iterator de methode next() aanbiedt. Die retourneert een promise die een resultaatobject oplevert. Als de eigenschap done ontbreekt, wordt het resultaat behandeld alsof het done: false bevat. Een resultaat met done: true geeft het einde van de iteratie aan en hoeft de eigenschap value niet te bevatten. De syntaxis async *[Symbol.asyncIterator]() definieert een asynchrone generatormethode die dit protocol automatisch afhandelt.
De lus for await...of zoekt eerst naar Symbol.asyncIterator. Als de methode ontbreekt of de waarde null heeft, gebruikt de lus Symbol.iterator en past hij de synchrone iterator aan. Een gewone for...of-lus gebruikt Symbol.asyncIterator niet. Declareer de iterator-fabriek niet als een gewone async-methode: die zou een promise retourneren in plaats van een iterator.
In het voorbeeld maakt elke aanroep van de methode een nieuwe generator en verzamelt de lus de waarden op volgorde. Controleer de ondersteuning voor de syntaxis en het symbool in de doelomgeving; noch de aanwezigheid van Symbol.asyncIterator op zich, noch het gebruik van Node 24 in de repository bewijst browsercompatibiliteit.
Voorbeelden
const numbers = {
async *[Symbol.asyncIterator]() {
yield 1;
yield 2;
yield 3;
}
};
async function main() {
const values = [];
for await (const value of numbers) {
values.push(value);
}
console.log(values.join(', '));
}
main().catch(console.error);Resultaat
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.