yield

Probieren Sie es aus

function* foo(index) {
  while (index < 2) {
    yield index;
    index++;
  }
}

const iterator = foo(0);

console.log(iterator.next().value);
// Expected output: 0

console.log(iterator.next().value);
// Expected output: 1

Syntax

yield
yield expression

Parameter

expression Optional

Der Wert, der über das Iterator-Protokoll aus der Generatorfunktion ausgegeben wird. Wenn weggelassen, wird undefined ausgegeben.

Rückgabewert

Gibt den optionalen Wert zurück, der an die next() Methode des Generators übergeben wurde, um die Ausführung fortzusetzen.

Beschreibung

Das Schlüsselwort yield pausiert die Ausführung einer Generatorfunktion und der Wert des Ausdrucks nach dem yield Schlüsselwort wird an den Aufrufer des Generators zurückgegeben. Es kann als generatorbasierte Version des return Schlüsselworts betrachtet werden.

yield kann nur direkt innerhalb der Generatorfunktion verwendet werden, die es enthält. Es kann nicht innerhalb verschachtelter Funktionen verwendet werden.

Der Aufruf einer Generatorfunktion erzeugt ein Generator Objekt. Jedes Mal, wenn die next() Methode des Generators aufgerufen wird, wird die Generatorausführung fortgesetzt und läuft bis zu einem der folgenden Punkte:

• Ein yield Ausdruck. In diesem Fall pausiert der Generator, und die next() Methode gibt ein Iterator-Ergebnis Objekt mit zwei Eigenschaften zurück: value und done. Die Eigenschaft value ist der Wert des Ausdrucks nach dem yield Operator, und done ist false, was darauf hinweist, dass die Generatorfunktion nicht vollständig abgeschlossen ist.
• Das Ende der Generatorfunktion. In diesem Fall endet die Ausführung des Generators, und die next() Methode gibt ein Iterator-Ergebnisobjekt zurück, bei dem value undefined ist und done true.
• Eine return Anweisung. In diesem Fall endet die Ausführung des Generators, und die next() Methode gibt ein Iterator-Ergebnisobjekt zurück, bei dem value der angegebene Rückgabewert ist und done true.
• Eine throw Anweisung. In diesem Fall wird die Ausführung des Generators vollständig gestoppt, und die next() Methode löst die angegebene Ausnahme aus.

Einmal auf einem yield Ausdruck pausiert, bleibt die Codeausführung des Generators angehalten, bis die next() Methode des Generators erneut aufgerufen wird. Wenn ein optionaler Wert an die next() Methode des Generators übergeben wird, wird dieser Wert als Rückgabewert der aktuellen yield Operation des Generators. Der erste next() Aufruf hat keine entsprechende angehaltene yield Operation, sodass es keine Möglichkeit gibt, das Argument des ersten next() Aufrufs abzurufen.

Wenn die return() oder throw() Methode des Generators aufgerufen wird, wirkt dies, als ob eine return oder throw Anweisung am pausierten yield Ausdruck ausgeführt wurde. Sie können try...catch...finally im Körper der Generatorfunktion verwenden, um diese vorzeitigen Abschlüsse zu behandeln. Wenn die return() oder throw() Methode aufgerufen wird, aber kein angehaltener yield Ausdruck vorhanden ist (weil next() noch nicht aufgerufen wurde oder weil der Generator bereits abgeschlossen ist), dann können die vorzeitigen Abschlüsse nicht behandelt werden und beenden den Generator immer.

Beispiele

Verwendung von yield

Der folgende Code ist die Deklaration einer Beispiel-Generatorfunktion.

function* countAppleSales() {
  const saleList = [3, 7, 5];
  for (const sale of saleList) {
    yield sale;
  }
}

Sobald eine Generatorfunktion definiert ist, kann ein Iterator wie folgt erstellt werden.

const appleStore = countAppleSales(); // Generator { }
console.log(appleStore.next()); // { value: 3, done: false }
console.log(appleStore.next()); // { value: 7, done: false }
console.log(appleStore.next()); // { value: 5, done: false }
console.log(appleStore.next()); // { value: undefined, done: true }

Sie können auch einen Wert mit next(value) in den Generator senden. step wird als Rückgabewert des yield Ausdrucks ausgewertet — obwohl der an die next() Methode des Generators übergebene Wert beim ersten Aufruf von next() ignoriert wird.

function* counter(value) {
  while (true) {
    const step = yield value++;

    if (step) {
      value += step;
    }
  }
}

const generatorFunc = counter(0);
console.log(generatorFunc.next().value); // 0
console.log(generatorFunc.next().value); // 1
console.log(generatorFunc.next().value); // 2
console.log(generatorFunc.next().value); // 3
console.log(generatorFunc.next(10).value); // 14
console.log(generatorFunc.next().value); // 15
console.log(generatorFunc.next(10).value); // 26

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Iterator-Protokolle
• function*
• function* Ausdruck
• yield*