AsyncGenerator
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
Das AsyncGenerator
-Objekt wird von einer async generator function zurückgegeben und entspricht sowohl dem async iterable protocol als auch dem async iterator protocol.
Async-Generator-Methoden geben immer Promise
-Objekte zurück.
AsyncGenerator
ist eine Unterklasse der versteckten AsyncIterator
-Klasse.
Konstruktor
Es gibt keine JavaScript-Entität, die dem AsyncGenerator
-Konstruktor entspricht. Instanzen von AsyncGenerator
müssen von async generator functions zurückgegeben werden:
async function* createAsyncGenerator() {
yield Promise.resolve(1);
yield await Promise.resolve(2);
yield 3;
}
const asyncGen = createAsyncGenerator();
asyncGen.next().then((res) => console.log(res.value)); // 1
asyncGen.next().then((res) => console.log(res.value)); // 2
asyncGen.next().then((res) => console.log(res.value)); // 3
Es gibt nur ein verstecktes Objekt, das das Prototyp-Objekt ist, das von allen Objekten geteilt wird, die von async generator functions erstellt werden. Dieses Objekt wird oft als AsyncGenerator.prototype
stilisiert, um es wie eine Klasse aussehen zu lassen, aber es sollte angemessener AsyncGeneratorFunction.prototype.prototype
genannt werden, da AsyncGeneratorFunction
eine tatsächliche JavaScript-Entität ist. Um die Prototypen-Kette von AsyncGenerator
-Instanzen zu verstehen, siehe AsyncGeneratorFunction.prototype.prototype
.
Instanz-Eigenschaften
Diese Eigenschaften sind auf AsyncGenerator.prototype
definiert und werden von allen AsyncGenerator
-Instanzen geteilt.
AsyncGenerator.prototype.constructor
-
Die Konstruktorfunktion, die das Instanzobjekt erstellt hat. Für
AsyncGenerator
-Instanzen ist der AnfangswertAsyncGeneratorFunction.prototype
.Hinweis:
AsyncGenerator
-Objekte speichern keinen Verweis auf die async generator function, die sie erstellt hat. AsyncGenerator.prototype[Symbol.toStringTag]
-
Der Anfangswert der
[Symbol.toStringTag]
-Eigenschaft ist der String"AsyncGenerator"
. Diese Eigenschaft wird inObject.prototype.toString()
verwendet.
Instanz-Methoden
Erbt ebenfalls Instanz-Methoden von seinem Elternteil AsyncIterator
.
AsyncGenerator.prototype.next()
-
Gibt ein
Promise
zurück, das mit dem angegebenen Wert aufgelöst wird, der durch denyield
-Ausdruck geliefert wird. AsyncGenerator.prototype.return()
-
Verhält sich so, als ob ein
return
-Statement im Körper des Generators an der aktuellen angehaltenen Position eingefügt wird, was den Generator beendet und es dem Generator ermöglicht, alle Aufräumaufgaben auszuführen, wenn es mit einemtry...finally
-Block kombiniert wird. AsyncGenerator.prototype.throw()
-
Verhält sich so, als ob ein
throw
-Statement im Körper des Generators an der aktuellen angehaltenen Position eingefügt wird, was den Generator über einen Fehlerzustand informiert und es ihm ermöglicht, den Fehler zu behandeln, oder Aufräumarbeiten durchzuführen und sich selbst zu schließen.
Beispiele
Async-Generator-Iteration
Das folgende Beispiel iteriert über einen async generator, der die Werte 1–6 in der Konsole bei abnehmenden Zeitintervallen protokolliert. Beachten Sie, wie jedes Mal ein Promise geliefert wird, das aber automatisch innerhalb der for await...of
-Schleife aufgelöst wird.
// An async task. Pretend it's doing something more useful
// in practice.
function delayedValue(time, value) {
return new Promise((resolve /*, reject */) => {
setTimeout(() => resolve(value), time);
});
}
async function* generate() {
yield delayedValue(2000, 1);
yield delayedValue(1000, 2);
yield delayedValue(500, 3);
yield delayedValue(250, 4);
yield delayedValue(125, 5);
yield delayedValue(50, 6);
console.log("All done!");
}
async function main() {
for await (const value of generate()) {
console.log("value", value);
}
}
main().catch((e) => console.error(e));
Spezifikationen
Specification |
---|
ECMAScript® 2026 Language Specification # sec-asyncgenerator-objects |