CKTIS / JavaScript
Symbol.asyncIterator — das asynchrone Iterationsprotokoll
Symbol.asyncIterator ist ein integriertes Symbol, das die Methode kennzeichnet, mit der ein Objekt seinen asynchronen Iterator bereitstellt. Dadurch kann for await...of aufeinanderfolgende Werte abrufen und dabei auf die Ergebnisse von next() warten.
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
Symbol.asyncIterator
object[Symbol.asyncIterator]()
async *[Symbol.asyncIterator]() { /* yield values */ }Symbol.asyncIterator ist ein bekanntes Symbol, das als Eigenschaftsschlüssel verwendet wird und keine Funktion ist, die direkt aufgerufen wird. Die Methode object[Symbol.asyncIterator]() gibt einen asynchronen Iterator zurück – das Iteratorobjekt selbst, nicht ein Promise für einen Iterator. Dieser Mechanismus gehört seit ECMAScript 2018 (ES2018) zu ECMAScript; er ist keine Web-API.
Ein asynchron iterierbares Objekt stellt diese Methode bereit, während ein asynchroner Iterator next() bereitstellt. Diese Methode gibt ein Promise für ein Ergebnisobjekt zurück. Fehlt die Eigenschaft done, wird das wie done: false behandelt. Ein Ergebnis mit done: true signalisiert das Ende der Iteration; die Eigenschaft value kann in diesem Ergebnis fehlen. Die Syntax async *[Symbol.asyncIterator]() definiert eine asynchrone Generatormethode, die dieses Protokoll automatisch umsetzt.
Die Schleife for await...of sucht zuerst nach Symbol.asyncIterator. Fehlt die Methode oder hat sie den Wert null, verwendet die Schleife Symbol.iterator und passt den synchronen Iterator an. Eine gewöhnliche for...of-Schleife verwendet Symbol.asyncIterator nicht. Deklariere die Iterator-Fabrik nicht als einfache async-Methode: Sie würde ein Promise statt eines Iterators zurückgeben.
Im Beispiel erzeugt jeder Methodenaufruf einen neuen Generator, und die Schleife sammelt die Werte der Reihe nach. Prüfe die Unterstützung der Syntax und des Symbols in der Zielumgebung; weder das bloße Vorhandensein von Symbol.asyncIterator noch die Verwendung von Node 24 im Repository belegt die Browserkompatibilität.
Beispiele
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);Ergebnis
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.