Generator.prototype.return()

Die return() Gibt den gegebenen Wert und beendet den Generator

Syntax

gen.return(value)

Parameter

value
Wert, der zurückgegeben werden soll.

Rückgabewert

Der als Argument angegebene Wert.

Beispiele

Einsatz von return()

Das folgende Beispiel zeigt einen einfachen Generator und den Einsatz der return Methode.

function* gen() {
  yield 1;
  yield 2;
  yield 3;
}

var g = gen();

g.next();        // { value: 1, done: false }
g.return('foo'); // { value: "foo", done: true }
g.next();        // { value: undefined, done: true }

Wenn return(value) auf einem Generator aufgerufen wird, der schon den Status "completed" hat, bleibt diese auch in diesem Status. Wenn kein Argument übergeben wird, wird das selbe Objekt wir bei .next() zurückgegeben. Wenn ein Parameter übergeben wird, wird dieses als value Eigenschaft beim zurückgegebenen Objekt zurückgegeben.

function* gen() {
  yield 1;
  yield 2;
  yield 3;
}

var g = gen();
g.next(); // { value: 1, done: false }
g.next(); // { value: 2, done: false }
g.next(); // { value: 3, done: false }
g.next(); // { value: undefined, done: true }
g.return(); // { value: undefined, done: true }
g.return(1); // { value: 1, done: true }

Spezifikationen

Spezifikation Status Kommentar
ECMAScript 2015 (6th Edition, ECMA-262)
Die Definition von 'Generator.prototype.return' in dieser Spezifikation.
Standard Initiale Definition.
ECMAScript (ECMA-262)
Die Definition von 'Generator.prototype.return' in dieser Spezifikation.
Lebender Standard  

Browserkompatibilität

BCD tables only load in the browser

Siehe auch