AsyncGenerator.prototype.return()

Syntax

asyncGeneratorInstance.return()
asyncGeneratorInstance.return(value)

Parameter

value Optional

Der zurckzugebende Wert.

Rckgabewert

Ein Promise, das mit einem Object aufgelst 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-Ausdrcke 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 zurckgegebene/geyieldete Wert.

Beschreibung

Die return()-Methode kann, wenn sie aufgerufen wird, so betrachtet werden, als ob eine return value;-Anweisung an der aktuellen Stelle des angehaltenen Generator-Krpers eingefgt 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 } zurckgegeben. Ist der yield-Ausdruck jedoch in einem try...finally-Block eingeschlossen, verlsst der Kontrollfluss den Funktionskrper nicht sofort, sondern fhrt mit dem finally-Block fort. In diesem Fall kann der zurckgegebene Wert unterschiedlich sein, und done kann sogar false sein, wenn es noch mehr yield-Ausdrcke innerhalb des finally-Blocks gibt.

Beispiele

Verwendung von return()

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 }

Verwendung von return() nachdem ein Generator abgeschlossen ist

Wenn kein value-Argument an die return()-Methode bergeben wird, wird das Promise aufgelst, als ob die next()-Methode aufgerufen wurde. In diesem Beispiel ist der Generator abgeschlossen, sodass der zurckgegebene 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 }

Spezifikationen

Browser-Kompatibilitt

Siehe auch

• async function*
• Iteratoren und Generatoren Leitfaden