yield*

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2016.

Der yield*-Operator kann innerhalb von Generatorfunktionen (synchron oder asynchron) verwendet werden, um an ein anderes iterierbares Objekt wie einen Generator zu delegieren. Innerhalb von asynchronen Generatorfunktionen kann er zusätzlich verwendet werden, um an ein anderes asynchrones iterierbares Objekt wie einen AsyncGenerator zu delegieren.

Probieren Sie es aus

function* func1() {
  yield 42;
}

function* func2() {
  yield* func1();
}

const iterator = func2();

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

Syntax

js
yield* expression

Parameter

expression Optional

Ein iterierbares Objekt.

Rückgabewert

Gibt den Wert zurück, der vom Iterator zurückgegeben wird, wenn er geschlossen ist (wenn done true ist).

Beschreibung

Der Ausdruck yield* iteriert über den Operanden und gibt jeden von diesem zurückgegebenen Wert aus. Er delegiert die Iteration des aktuellen Generators an einen zugrundeliegenden Iterator – auf die wir uns als "Generator" und "Iterator" beziehen werden. yield* ruft zunächst die Methode [Symbol.iterator]() des Operanden auf, um den Iterator zu erhalten. Jedes Mal, wenn die next()-Methode des Generators aufgerufen wird, ruft yield* die next()-Methode des Iterators auf, übergibt das Argument, das von der next()-Methode des Generators empfangen wurde (immer undefined beim ersten Aufruf), und gibt dasselbe Ergebnisobjekt zurück, das von der next()-Methode des Iterators zurückgegeben wird. Wenn das Iterator-Ergebnis done: true hat, hört der yield*-Ausdruck auf zu arbeiten und gibt den value dieses Ergebnisses zurück.

Der yield*-Operator leitet die Methoden throw() und return() des aktuellen Generators ebenfalls an den zugrundeliegenden Iterator weiter. Wenn der aktuelle Generator durch eine dieser Methoden vorzeitig geschlossen wird, wird der zugrundeliegende Iterator benachrichtigt. Wenn die throw()-/return()-Methode des Generators aufgerufen wird, wird die throw()-/return()-Methode des zugrundeliegenden Iterators mit demselben Argument aufgerufen. Der Rückgabewert von throw()/return() wird wie das Ergebnis der next()-Methode behandelt, und wenn die Methode eine Ausnahme auslöst, wird diese vom yield*-Ausdruck weitergegeben.

Wenn der zugrundeliegende Iterator keine return()-Methode hat, verwandelt sich der yield*-Ausdruck in eine return-Anweisung, genau wie das Aufrufen von return() bei einem angehaltenen yield-Ausdruck.

Wenn der zugrundeliegende Iterator keine throw()-Methode hat, führt dies dazu, dass yield* einen TypeError auslöst – aber bevor der Fehler ausgelöst wird, wird die return()-Methode des zugrundeliegenden Iterators aufgerufen, falls eine existiert.

Beispiele

Delegieren an einen anderen Generator

Im folgenden Code werden die von g1() erzeugten Werte bei next()-Aufrufen genauso zurückgegeben wie die von g2() erzeugten.

js
function* g1() {
  yield 2;
  yield 3;
  yield 4;
}

function* g2() {
  yield 1;
  yield* g1();
  yield 5;
}

const gen = g2();

console.log(gen.next()); // {value: 1, done: false}
console.log(gen.next()); // {value: 2, done: false}
console.log(gen.next()); // {value: 3, done: false}
console.log(gen.next()); // {value: 4, done: false}
console.log(gen.next()); // {value: 5, done: false}
console.log(gen.next()); // {value: undefined, done: true}

Andere iterierbare Objekte

Neben Generatorobjekten kann yield* auch andere Arten von iterierbaren Objekten ausgeben (z. B. Arrays, Strings oder arguments-Objekte).

js
function* g3(...args) {
  yield* [1, 2];
  yield* "34";
  yield* args;
}

const gen = g3(5, 6);

console.log(gen.next()); // {value: 1, done: false}
console.log(gen.next()); // {value: 2, done: false}
console.log(gen.next()); // {value: "3", done: false}
console.log(gen.next()); // {value: "4", done: false}
console.log(gen.next()); // {value: 5, done: false}
console.log(gen.next()); // {value: 6, done: false}
console.log(gen.next()); // {value: undefined, done: true}

Der Wert des yield*-Ausdrucks selbst

yield* ist ein Ausdruck, keine Anweisung, daher wertet er zu einem Wert aus.

js
function* g4() {
  yield* [1, 2, 3];
  return "foo";
}

function* g5() {
  const g4ReturnValue = yield* g4();
  console.log(g4ReturnValue); // 'foo'
  return g4ReturnValue;
}

const gen = g5();

console.log(gen.next()); // {value: 1, done: false}
console.log(gen.next()); // {value: 2, done: false}
console.log(gen.next()); // {value: 3, done: false} done is false because g5 generator isn't finished, only g4
console.log(gen.next()); // {value: 'foo', done: true}

Verwendung mit asynchronen Generatoren

js
async function* g1() {
  await Promise.resolve(0);
  yield "foo";
}

function* g2() {
  yield "bar";
}

async function* g3() {
  // Can use yield* on both async and sync iterators
  yield* g1();
  yield* g2();
}

const gen = g3();

console.log(await gen.next()); // {value: "foo", done: false}
console.log(await gen.next()); // {value: "bar", done: false}
console.log(await gen.next()); // {done: true}

Methodenweiterleitung

Die Methoden next(), throw() und return() des aktuellen Generators werden alle an den zugrundeliegenden Iterator weitergeleitet.

js
const iterable = {
  [Symbol.iterator]() {
    let count = 0;
    return {
      next(v) {
        console.log("next called with", v);
        count++;
        return { value: count, done: false };
      },
      return(v) {
        console.log("return called with", v);
        return { value: "iterable return value", done: true };
      },
      throw(v) {
        console.log("throw called with", v);
        return { value: "iterable thrown value", done: true };
      },
    };
  },
};

function* gf() {
  yield* iterable;
  return "gf return value";
}

const gen = gf();
console.log(gen.next(10));
// next called with undefined; the argument of the first next() call is always ignored
// { value: 1, done: false }
console.log(gen.next(20));
// next called with 20
// { value: 2, done: false }
console.log(gen.return(30));
// return called with 30
// { value: 'iterable return value', done: true }
console.log(gen.next(40));
// { value: undefined, done: true }; gen is already closed

const gen2 = gf();
console.log(gen2.next(10));
// next called with undefined
// { value: 1, done: false }
console.log(gen2.throw(50));
// throw called with 50
// { value: 'gf return value', done: true }
console.log(gen.next(60));
// { value: undefined, done: true }; gen is already closed

Falls die return()-/throw()-Methode des zugrundeliegenden Iterators done: false zurückgibt, setzt der aktuelle Generator die Ausführung fort, und yield* delegiert weiterhin an den zugrundeliegenden Iterator.

js
const iterable = {
  [Symbol.iterator]() {
    let count = 0;
    return {
      next(v) {
        console.log("next called with", v);
        count++;
        return { value: count, done: false };
      },
      return(v) {
        console.log("return called with", v);
        return { value: "iterable return value", done: false };
      },
    };
  },
};

function* gf() {
  yield* iterable;
  return "gf return value";
}

const gen = gf();
console.log(gen.next(10));
// next called with undefined
// { value: 1, done: false }
console.log(gen.return(20));
// return called with 20
// { value: 'iterable return value', done: false }
console.log(gen.next(30));
// { value: 2, done: false }; gen is not closed

Falls der zugrundeliegende Iterator keine throw()-Methode besitzt und die throw()-Methode des Generators aufgerufen wird, löst yield* einen Fehler aus.

js
const iterable = {
  [Symbol.iterator]() {
    let count = 0;
    return {
      next(v) {
        count++;
        return { value: count, done: false };
      },
    };
  },
};

function* gf() {
  yield* iterable;
  return "gf return value";
}

const gen = gf();
gen.next(); // First next() starts the yield* expression
gen.throw(20); // TypeError: The iterator does not provide a 'throw' method.

Spezifikationen

Specification
ECMAScript® 2025 Language Specification
# sec-generator-function-definitions-runtime-semantics-evaluation

Browser-Kompatibilität

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
Node.js
yield*

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
See implementation notes.

Siehe auch