function*

Die function* Deklaration ( Schlüsselwort function gefolgt von einem Stern) definiert eine Generatorfunktion, welche ein  Generator Objekt zurückgibt.

Syntax

function* name([param[, param[, ... param]]]) {
   statements
}

name

Der Name der Funktion.

param

Der Name eines an die Funktion zu übergebenden Arguments. Eine Funktion kann bis zu 255 Argumente haben.

statements

Die den Körper der Funktion ergebenenden Anweisungen.

Beschreibung

Generatoren sind Funktionen, die verlassen und später wieder betreten werden können. Ihr Kontext (Variablenbindungen) bleiben über die Wiedereintritte hinweg erhalten.

Der Aufruf einer Generatorfunktion führt ihren Körper nicht sofort aus; stattdessen wird ein Iteratorobjekt der Funktion zurückgegeben. Wenn die next() Methode des Iterators aufgerufen wird, wird der Körper der Generatorfunktion bis zum ersten yield Ausdruck ausgeführt, der den vom Iterator zurückzugebenden Wert spezifiziert, oder mittels yield* an eine andere Generatorfunktion weitergibt. Die Methode next() gibt ein Objekt mit einer value Eigenschaft zurück, die den zurückgegebenen Wert enthält und eine Eigenschaft done, die anzeigt, ob der Generator seinen letzten Wert zurückgegeben hat (boolischer Wert). Beim Aufrufen der next() Methode mit einem Argument wird die generator Funktion weiter ausgeführt.

Beispiele

Einfaches Beispiel

function* idMaker(){
  var index = 0;
  while(index < 3)
    yield index++;
}

var gen = idMaker();

console.log(gen.next().value); // 0
console.log(gen.next().value); // 1
console.log(gen.next().value); // 2
console.log(gen.next().value); // undefined
// ...

Beispiel mit yield*

function* anotherGenerator(i) {
  yield i + 1;
  yield i + 2;
  yield i + 3;
}

function* generator(i) {
  yield i;
  yield* anotherGenerator(i);
  yield i + 10;
}

var gen = generator(10);

console.log(gen.next().value); // 10
console.log(gen.next().value); // 11
console.log(gen.next().value); // 12
console.log(gen.next().value); // 13
console.log(gen.next().value); // 20

Übergeben von Argumenten in Generatoren

function* logGenerator() {
  console.log(yield);
  console.log(yield);
  console.log(yield);
}

var gen = logGenerator();

// the first call of next executes from the start of the function
// until the first yield statement
gen.next(); 
gen.next('pretzel'); // pretzel
gen.next('california'); // california
gen.next('mayonnaise'); // mayonnaise

Generatoren haben keinen Konstruktor

function* f() {}
var obj = new f; // throws "TypeError: f ist kein Konstruktor"

Spezifikationen

Browserkompatibilität

Firefox-spezifische Hinweise

Generatoren und Iteratoren in Firefox-Versionen vor 26

Ältere Firefox-Versionen implementierten eine ältere Version des Generatorenentwurfs. In den älteren Versionen wurden Generatoren, neben anderen Abweichungen, mit dem normalen Schlüsselwort function (ohne den Stern) definiert. Siehe Veraltete Generatorfunktion für weitere Informationen.

IteratorResult Objekt zurückgegeben anstatt Ausnahme erzeugt

Beginnend mit Gecko 29 (Firefox 29 / Thunderbird 29 / SeaMonkey 2.26) erzeugt die ausgeführte Generatorfunktion keine TypeError "generator has already finished" Ausnahme mehr. Stattdessen gibt sie ein IteratorResult Objekt mit { value: undefined, done: true } (Bug 958951) zurück.

Siehe auch

• function* expression
• GeneratorFunction Objekt
• Das Iteratorprotokol
• yield
• yield*
• Function object
• function declaration
• function expression
• Functions and function scope
• Andere Quellen im Web:
  • Regenerator an ES2015 generator compiler to ES5
  • Forbes Lindesay: Promises and Generators: control flow utopia -- JSConf EU 2013
  • Hemanth.HM: The New gen of *gen(){}
  • Task.js