WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

Generatorfunktion: function*

Eine Generatorfunktion erzeugt einen Iterator, dessen Ausführung bei yield pausiert und mit next() fortgesetzt werden kann. Sie berechnet Werte bei Bedarf und behält den lokalen Zustand zwischen aufeinanderfolgenden Schritten bei.

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

function* name(parameters) {
  yield value;
  return finalValue;
}

Die Deklaration function* name(parameters) { ... } definiert eine Generatorfunktion. Beim Aufruf wird ein neues Generator-Objekt erzeugt, der Funktionskörper wird jedoch noch nicht ausgeführt. Jedes Objekt besitzt einen eigenen Ausführungszustand; das erste next() startet den Funktionskörper, und yield value liefert einen Wert und pausiert die Ausführung.

Ein weiteres next() setzt die Ausführung nach yield fort und behält lokale Variablen bei. Das Ergebnis hat die Felder value und done: yield ergibt done: false, während return finalValue den Generator mit done: true beendet. Ohne ausdrückliches return ist der Endwert undefined. Nach dem Ende liefern weitere Aufrufe von next() value: undefined und done: true.

Ein Generatorobjekt ist sowohl ein Iterator als auch ein iterierbares Objekt. for...of und die Spread-Syntax (...) in Array-Literalen und in Argumentlisten von Funktionsaufrufen verarbeiten Werte aus yield, lassen aber den Endwert aus return aus. In Objektliteralen setzt die Spread-Syntax die Ausführung des Generators nicht fort, sondern kopiert die eigenen aufzählbaren Eigenschaften des Generatorobjekts. Ein aufgebrauchter Generator kann nicht neu gestartet werden; rufen Sie stattdessen die Funktion erneut auf. Ein Argument für next(value) wird zum Ergebnis des pausierten yield-Ausdrucks; das Argument des ersten next() wird ignoriert.

Sie können einen Generator auch mit einem Ausdruck wie const make = function* () { yield 1; }; definieren, wobei der Funktionsname optional ist. Eine Generator-Syntax für Pfeilfunktionen gibt es nicht. MDN stuft function* seit September 2016 als breit in Browsern verfügbar ein; prüfen Sie die Unterstützung im Zielbrowser separat.

Beispiele

function* steps() {
  yield 10;
  yield 20;
  return 30;
}

const iterator = steps();
for (let i = 0; i < 4; i++) {
  const { value, done } = iterator.next();
  console.log(`${value} | ${done}`);
}
console.log([...steps()].join(", "));

Ergebnis

10 | false
20 | false
30 | true
undefined | true
10, 20

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.

Quellen