WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

Iteratorprotokoll: next(), return(), value und done

Prüfe `done` statt `value`, um das Ende der Iteration zu erkennen. Lerne, wie du den Abschlusswert liest und wann `for...of` das optionale `return()` aufruft.

Version: ECMAScript 2024 and the current web platform; runtime support varies

Syntax

const iterator = iterable[Symbol.iterator]();
const result = iterator.next();
// result.done: completion flag; result.value: element or completion value
// When stopping early during manual iteration, call the optional method if callable:
if (typeof iterator.return === "function") {
  iterator.return();
}

Ein synchroner Iterator ist ein Objekt mit der Methode next(), die ein Ergebnisobjekt (IteratorResult) zurückgibt. Ein iterierbares Objekt besitzt die Methode [Symbol.iterator](), die einen Iterator liefert. next() allein macht ein Objekt nicht iterierbar; ein Generatorobjekt erfüllt beide Rollen. for...of holt den Iterator und ruft next() ohne Argumente auf. Was ein übergebenes Argument bedeutet, hängt von der Implementierung des Iterators ab.

Bei done: false ist value ein Element, selbst wenn es undefined ist. done: true bedeutet, dass die Iteration beendet ist. value kann dann einen Abschlusswert enthalten, den for...of nicht an den Schleifenrumpf weitergibt. Ein fehlendes done zählt als false; for...of prüft die Eigenschaft nach der Umwandlung in einen booleschen Wert. Nach dem Ende sollte auch jeder weitere next()-Aufruf done: true melden. Die Sprache erzwingt das nicht.

Die optionale Methode return(value) signalisiert, dass der Aufrufer aufhört, und ermöglicht dem Iterator, Ressourcen freizugeben. Das Ergebnis enthält üblicherweise done: true und das Argument als value. Ein Generator kann aber done: false melden, wenn er in finally ein yield ausführt. Bei vorzeitigem Verlassen durch break oder eine Ausnahme im Schleifenrumpf ruft for...of ein vorhandenes return() ohne Argumente auf und ignoriert done und value des Ergebnisses. Bei normalem Ende oder wenn next() selbst eine Ausnahme auslöst, findet dieser Aufruf nicht statt.

Manuelle next()-Aufrufe schließen den Iterator nicht automatisch. Wenn du vorzeitig aufhörst, rufe return() selbst auf, sofern es aufrufbar ist. Liefert next() oder der Aufruf von return() beim Schließen kein Objekt, löst for...of einen TypeError aus. Wurde das Schließen durch eine Ausnahme im Schleifenrumpf ausgelöst, hat die ursprüngliche Ausnahme Vorrang.

Beispiele

{
  function* sequence() {
    try {
      yield undefined;
      return "end";
    } finally {
      console.log("cleanup");
    }
  }

  function show(label, { done, value }) {
    console.log(`${label}: done=${done}, value=${value}`);
  }

  const full = sequence();
  show("next", full.next());
  show("next", full.next());
  show("next", full.next());

  for (const value of sequence()) {
    console.log(`loop: ${value}`);
    break;
  }

  const manual = sequence();
  manual.next();
  show("return", manual.return("stopped"));
}

Ergebnis

next: done=false, value=undefined
cleanup
next: done=true, value=end
next: done=true, value=undefined
loop: undefined
cleanup
cleanup
return: done=true, value=stopped

Drei getrennte Generatoren zeigen das normale Ende mit dem Abschlusswert `end`, das automatische Schließen durch `break` und den direkten Aufruf `return("stopped")`. Jeder gestartete Generator gibt im `finally`-Block `cleanup` aus.

Zugehörige Lektionen

  • JavaScript · Lektion 8 · Fortgeschritten · Version: 4

Quellen