AsyncGenerator.prototype.return()

value Optional

Der zurückzugebende Wert.

Ein Promise, das mit einem Object aufgelöst wird, das zwei Eigenschaften hat:

done

Ein boolescher Wert:

• true, wenn der Kontrollfluss der Generatorfunktion das Ende erreicht hat.
• false, wenn der Kontrollfluss der Generatorfunktion das Ende nicht erreicht hat und noch mehr Werte erzeugen kann. Dies kann nur passieren, wenn das return in einem try...finally eingefangen wird und es mehr yield-Ausdrücke im finally-Block gibt.

value

Der Wert, der als Argument übergeben wird, oder, wenn der yield-Ausdruck in einem try...finally eingeschlossen ist, der aus dem finally-Block zurückgegebene/geyieldete Wert.

Die return()-Methode kann, wenn sie aufgerufen wird, so betrachtet werden, als ob eine return value;-Anweisung an der aktuellen Stelle des angehaltenen Generator-Körpers eingefügt wird, wobei value der Wert ist, der an die return()-Methode übergeben wird. Daher wird normalerweise beim Aufruf von return(value) { done: true, value: value } zurückgegeben. Ist der yield-Ausdruck jedoch in einem try...finally-Block eingeschlossen, verlässt der Kontrollfluss den Funktionskörper nicht sofort, sondern fährt mit dem finally-Block fort. In diesem Fall kann der zurückgegebene Wert unterschiedlich sein, und done kann sogar false sein, wenn es noch mehr yield-Ausdrücke innerhalb des finally-Blocks gibt.

Das folgende Beispiel zeigt einen asynchronen Generator und die Verwendung der return-Methode.

// 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* createAsyncGenerator() {
  yield delayedValue(500, 1);
  yield delayedValue(500, 2);
  yield delayedValue(500, 3);
}

const asyncGen = createAsyncGenerator();
asyncGen.next().then((res) => console.log(res)); // { value: 1, done: false }
asyncGen.return("foo").then((res) => console.log(res)); // { value: "foo", done: true }
asyncGen.next().then((res) => console.log(res)); // { value: undefined, done: true }

Wenn kein value-Argument an die return()-Methode übergeben wird, wird das Promise aufgelöst, als ob die next()-Methode aufgerufen wurde. In diesem Beispiel ist der Generator abgeschlossen, sodass der zurückgegebene Wert undefined ist.

return() kann weiterhin aufgerufen werden, nachdem der Generator in einem "abgeschlossenen" Zustand ist, allerdings bleibt der Generator in diesem Zustand.

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, done: false }
asyncGen.next().then((res) => console.log(res)); // { value: 2, done: false }
asyncGen.next().then((res) => console.log(res)); // { value: 3, done: false }
// value is returned undefined, as no value is passed and generator is 'done'
asyncGen.return().then((res) => console.log(res)); // { value: undefined, done: true }
// we can still return a value once the generator is complete
asyncGen.return(1).then((res) => console.log(res)); // { value: 1, done: true }

• async function*
• Iteratoren und Generatoren Leitfaden