Dieser Inhalt wurde automatisch aus dem Englischen übersetzt, und kann Fehler enthalten. Erfahre mehr über dieses Experiment.

View in English Always switch to English

Iterator

Baseline
Weitgehend verfügbar
*

Diese Funktion ist gut etabliert und funktioniert auf vielen Geräten und in vielen Browserversionen. Sie ist seit September 2016 browserübergreifend verfügbar.

* Einige Teile dieser Funktion werden möglicherweise unterschiedlich gut unterstützt.

Ein Iterator-Objekt ist ein Objekt, das dem Iterator-Protokoll entspricht: Es stellt eine next()-Methode bereit, die ein Iterator-Ergebnisobjekt zurückgibt. Alle integrierten Iteratoren erben von der Klasse Iterator. Die Klasse Iterator stellt eine [Symbol.iterator]()-Methode bereit, die das Iterator-Objekt selbst zurückgibt. Dadurch ist der Iterator auch iterierbar. Außerdem bietet die Klasse einige Hilfsmethoden für die Arbeit mit Iteratoren.

Beschreibung

Die folgenden Objekte sind allesamt integrierte JavaScript-Iteratoren:

Auch Web-APIs können Iteratoren zurückgeben. Einige verwenden JavaScript-Iteratoren wieder, während andere eigene Iteratoren definieren. Zum Beispiel:

  • Array-ähnliche Objekte wie NodeList geben über ihre jeweiligen Methoden keys(), values(), entries() und [Symbol.iterator]() einen Array Iterator zurück.
  • Map-ähnliche Objekte aus Web-APIs wie Headers geben über ihre jeweiligen Methoden keys(), values(), entries() und [Symbol.iterator]() einen eigenen Iteratortyp wie den Headers Iterator zurück.
  • Set-ähnliche Objekte aus Web-APIs wie FontFaceSet geben über ihre jeweiligen Methoden keys(), values(), entries() und [Symbol.iterator]() einen eigenen Iteratortyp wie den FontFaceSet Iterator zurück.

Hinweis: NodeIterator und andere ältere Schnittstellen tragen zwar entsprechende Namen, entsprechen aber weder dem Iterator-Protokoll noch dem Iterable-Protokoll.

Jeder dieser Iteratoren hat ein eigenes Prototypobjekt, das die vom jeweiligen Iterator verwendete next()-Methode definiert. Beispielsweise erben alle String-Iterator-Objekte von einem verborgenen Objekt namens StringIteratorPrototype. Dessen next()-Methode iteriert über den String nach Codepunkten. StringIteratorPrototype besitzt außerdem eine [Symbol.toStringTag]-Eigenschaft, deren Anfangswert der String "String Iterator" ist. Diese Eigenschaft wird von Object.prototype.toString() verwendet. Auch die anderen Iterator-Prototypen besitzen jeweils eigene [Symbol.toStringTag]-Werte, die den oben genannten Namen entsprechen.

Alle diese Prototypobjekte erben von Iterator.prototype. Dieses stellt eine [Symbol.iterator]()-Methode bereit, die das Iterator-Objekt selbst zurückgibt. Dadurch ist der Iterator auch iterierbar.

Iterator-Hilfsmethoden

Hinweis: Diese Methoden sind Hilfsmethoden für Iteratoren, nicht für iterierbare Objekte. Damit ein Objekt iterierbar ist, muss es lediglich eine [Symbol.iterator]()-Methode besitzen. Es gibt keinen gemeinsamen Prototyp, auf dem sich diese Hilfsmethoden bereitstellen ließen.

Die Klasse Iterator selbst stellt einige Hilfsmethoden für die Arbeit mit Iteratoren bereit. Beispielsweise könnten Sie versucht sein, Folgendes zu tun:

js
const nameToDeposit = new Map([
  ["Anne", 1000],
  ["Bert", 1500],
  ["Carl", 2000],
]);

const totalDeposit = [...nameToDeposit.values()].reduce((a, b) => a + b);

Dabei wird der von Map.prototype.values() zurückgegebene Iterator zunächst in ein Array umgewandelt. Anschließend wird mit der Methode Array.prototype.reduce() die Summe berechnet. Dadurch entsteht jedoch ein Zwischenarray, und die Werte werden zweimal durchlaufen. Stattdessen können Sie die reduce()-Methode des Iterators selbst verwenden:

js
const totalDeposit = nameToDeposit.values().reduce((a, b) => a + b);

Diese Methode kann insbesondere hinsichtlich des Speicherbedarfs effizienter sein, weil sie den Iterator nur einmal durchläuft und keine Zwischenwerte speichert. Für die Arbeit mit unendlichen Iteratoren sind Iterator-Hilfsmethoden erforderlich:

js
function* fibonacci() {
  let current = 1;
  let next = 1;
  while (true) {
    yield current;
    [current, next] = [next, current + next];
  }
}

const seq = fibonacci();
const firstThreeDigitTerm = seq.find((n) => n >= 100);

Sie können seq nicht in ein Array umwandeln, da der Iterator unendlich ist. Stattdessen können Sie die find()-Methode des Iterators selbst verwenden. Sie durchläuft seq nur so weit, wie es nötig ist, um den ersten Wert zu finden, der die Bedingung erfüllt.

Viele Iterator-Methoden entsprechen sinngemäß Array-Methoden, zum Beispiel:

Iterator-Methode Array-Methode
Iterator.prototype.every() Array.prototype.every()
Iterator.prototype.filter() Array.prototype.filter()
Iterator.prototype.find() Array.prototype.find()
Iterator.prototype.flatMap() Array.prototype.flatMap()
Iterator.prototype.forEach() Array.prototype.forEach()
Iterator.prototype.includes() Array.prototype.includes()
Iterator.prototype.join() Array.prototype.join()
Iterator.prototype.map() Array.prototype.map()
Iterator.prototype.reduce() Array.prototype.reduce()
Iterator.prototype.some() Array.prototype.some()

Iterator.prototype.drop() und Iterator.prototype.take() entsprechen zusammen in gewisser Weise Array.prototype.slice().

Iterator-Hilfsobjekte

Hinweis: Iterator-Hilfsobjekte und Iterator-Hilfsmethoden sind zwei verschiedene Konzepte. Ein Iterator-Hilfsobjekt lässt sich zur Laufzeit erkennen, während „Iterator-Hilfsmethode“ lediglich eine Bezeichnung für eine Gruppe von Methoden ist. Je nach Kontext kann sich Iterator Helper auf das Objekt oder die Methode beziehen.

Von den Iterator-Hilfsmethoden geben filter(), flatMap(), map(), drop() und take() ein neues Iterator Helper-Objekt zurück. Dieses Hilfsobjekt ist ebenfalls eine Iterator-Instanz, sodass sich die Hilfsmethoden verketten lassen. Alle Iterator-Hilfsobjekte erben von einem gemeinsamen Prototypobjekt, das das Iterator-Protokoll implementiert:

next()

Ruft die next()-Methode des zugrunde liegenden Iterators auf, wendet die Hilfsmethode auf das Ergebnis an und gibt das Ergebnis zurück.

return()

Ruft die return()-Methode des zugrunde liegenden Iterators auf und gibt das Ergebnis zurück.

Das Iterator-Hilfsobjekt verwendet dieselbe Datenquelle wie der zugrunde liegende Iterator. Wird das Hilfsobjekt durchlaufen, wird daher auch der zugrunde liegende Iterator durchlaufen. Es gibt keine Möglichkeit, einen Iterator zu „verzweigen“, um ihn mehrfach durchlaufen zu können.

js
const it = [1, 2, 3].values();
const it2 = it.drop(0); // Essentially a copy
console.log(it.next().value); // 1
console.log(it2.next().value); // 2
console.log(it.next().value); // 3

Vollwertige Iteratoren

Es gibt zwei Arten von „Iteratoren“: Objekte, die dem Iterator-Protokoll entsprechen (wofür mindestens eine next()-Methode erforderlich ist), und Objekte, die von der Klasse Iterator erben und damit über die Hilfsmethoden verfügen. Das eine bedingt nicht das andere: Objekte, die von Iterator erben, werden nicht automatisch zu Iteratoren, da die Klasse Iterator keine next()-Methode definiert. Das Objekt muss selbst eine next()-Methode definieren. Ein vollwertiger Iterator entspricht sowohl dem Iterator-Protokoll als auch dem Erbschaftsmodell von Iterator. Der meiste Code erwartet vollwertige Iteratoren und setzt voraus, dass iterierbare Objekte vollwertige Iteratoren zurückgeben. Um einen vollwertigen Iterator zu erstellen, definieren Sie eine Klasse, die Iterator erweitert, oder verwenden Sie die Methode Iterator.from().

js
class MyIterator extends Iterator {
  next() {
    // …
  }
}

const myIterator = Iterator.from({
  next() {
    // …
  },
});

Konstruktor

Iterator()

Ist dafür vorgesehen, von anderen Klassen erweitert zu werden, die Iteratoren erzeugen. Wird der Konstruktor direkt aufgerufen, wird ein Fehler ausgelöst.

Statische Methoden

Iterator.concat()

Erstellt aus einer Liste iterierbarer Objekte ein neues Iterator-Objekt. Der neue Iterator liefert nacheinander die Werte jedes iterierbaren Eingabeobjekts.

Iterator.from()

Erstellt aus einem Iterator oder einem iterierbaren Objekt ein neues Iterator-Objekt.

Iterator.zip()

Erstellt ein neues Iterator-Objekt, das Elemente aus mehreren iterierbaren Objekten zusammenfasst. Es liefert Arrays mit den Elementen an der jeweils gleichen Position.

Iterator.zipKeyed()

Erstellt ein neues Iterator-Objekt, das Elemente aus mehreren iterierbaren Objekten zusammenfasst. Es liefert Objekte mit den Elementen an der jeweils gleichen Position, wobei die Schlüssel durch die Eingabe vorgegeben werden.

Instanzeigenschaften

Diese Eigenschaften sind auf Iterator.prototype definiert und werden von allen Iterator-Instanzen gemeinsam genutzt.

Iterator.prototype.constructor

Die Konstruktorfunktion, die das Instanzobjekt erstellt hat. Bei Iterator-Instanzen ist der Anfangswert der Konstruktor Iterator.

Iterator.prototype[Symbol.toStringTag]

Der Anfangswert der Eigenschaft [Symbol.toStringTag] ist der String "Iterator". Diese Eigenschaft wird von Object.prototype.toString() verwendet.

Hinweis: Anders als bei den meisten anderen integrierten Klassen sind die Eigenschaften constructor und [Symbol.toStringTag] von Iterator.prototype als Getter-Setter-Paare und nicht als gewöhnliche Dateneigenschaften implementiert. Der Grund dafür ist ein Problem mit der Web-Kompatibilität. Der Setter verhält sich wie eine nicht beschreibbare Dateneigenschaft (eine Zuweisung schlägt fehl), erlaubt Unterklassen aber, durch Zuweisung eigene entsprechende Eigenschaften anzulegen.

Instanzmethoden

Iterator.prototype.chunks()

Gibt ein neues Iterator-Hilfsobjekt zurück, das die Elemente des ursprünglichen Iterators in aufeinanderfolgende Array-Blöcke aufteilt. Bei jedem Iterationsschritt entnimmt das Hilfsobjekt dem zugrunde liegenden Iterator die angegebene Anzahl von Elementen und liefert sie gemeinsam.

Iterator.prototype.drop()

Gibt ein neues Iterator-Hilfsobjekt zurück, das die angegebene Anzahl von Elementen am Anfang dieses Iterators überspringt.

Iterator.prototype.every()

Gibt false zurück, wenn ein Element gefunden wird, das die bereitgestellte Prüffunktion nicht erfüllt. Andernfalls wird true zurückgegeben, wenn der Iterator vollständig durchlaufen wurde, ohne ein solches Element zu finden.

Iterator.prototype.filter()

Gibt ein neues Iterator-Hilfsobjekt zurück, das nur die Elemente des Iterators liefert, für die die bereitgestellte Callback-Funktion true zurückgibt.

Iterator.prototype.find()

Gibt das erste vom Iterator gelieferte Element zurück, das die bereitgestellte Prüffunktion erfüllt. Erfüllt kein Wert die Prüffunktion, wird undefined zurückgegeben.

Iterator.prototype.flatMap()

Gibt ein neues Iterator-Hilfsobjekt zurück, das jedes Element des ursprünglichen Iterators an eine Abbildungsfunktion übergibt und die von dieser Funktion zurückgegebenen Elemente liefert. Diese Elemente sind in einem anderen Iterator oder iterierbaren Objekt enthalten.

Iterator.prototype.forEach()

Führt eine bereitgestellte Funktion für jedes vom Iterator gelieferte Element einmal aus.

Iterator.prototype.includes()

Gibt true zurück, wenn ein vom Iterator geliefertes Element dem angegebenen Wert entspricht. Andernfalls wird false zurückgegeben, wenn der Iterator vollständig durchlaufen wurde, ohne ein solches Element zu finden.

Iterator.prototype.join()

Gibt einen String zurück, der durch Verkettung aller vom Iterator gelieferten Elemente entsteht. Die Elemente werden durch Kommas oder einen angegebenen Trennstring getrennt.

Iterator.prototype.map()

Gibt ein neues Iterator-Hilfsobjekt zurück, das die Elemente des Iterators liefert, nachdem sie jeweils durch eine Abbildungsfunktion umgewandelt wurden.

Iterator.prototype.reduce()

Führt für jedes vom Iterator gelieferte Element eine vom Benutzer bereitgestellte „Reducer“-Callback-Funktion aus und übergibt ihr das Ergebnis der Berechnung für das vorherige Element. Das Endergebnis der Anwendung des Reducers auf alle Elemente ist ein einzelner Wert.

Iterator.prototype.some()

Gibt true zurück, wenn ein Element gefunden wird, das die bereitgestellte Prüffunktion erfüllt. Andernfalls wird false zurückgegeben, wenn der Iterator vollständig durchlaufen wurde, ohne ein solches Element zu finden.

Iterator.prototype.take()

Gibt ein neues Iterator-Hilfsobjekt zurück, das die angegebene Anzahl von Elementen dieses Iterators liefert und danach endet.

Iterator.prototype.toArray()

Erstellt eine neue Array-Instanz, die mit den vom Iterator gelieferten Elementen gefüllt ist.

Iterator.prototype.windows()

Gibt ein neues Iterator-Hilfsobjekt zurück, das ein gleitendes Fenster von Elementen liefert. Bei jedem Iterationsschritt liefert es ein Array, bei dem gegenüber dem vorherigen Schritt das erste Element entfernt und das nächste Element des ursprünglichen Iterators hinzugefügt wurde.

Iterator.prototype[Symbol.dispose]()

Ruft die return()-Methode von this auf, sofern sie vorhanden ist. Dadurch wird das Disposable-Protokoll implementiert und ermöglicht die Freigabe bei Verwendung mit using oder await using.

Iterator.prototype[Symbol.iterator]()

Gibt das Iterator-Objekt selbst zurück. Dadurch können Iterator-Objekte zugleich iterierbar sein.

Beispiele

Einen Iterator als iterierbares Objekt verwenden

Alle integrierten Iteratoren sind auch iterierbar. Sie können sie daher in einer for...of-Schleife verwenden:

js
const arrIterator = [1, 2, 3].values();
for (const value of arrIterator) {
  console.log(value);
}
// Logs: 1, 2, 3

Spezifikationen

Spezifikation
ECMAScript® 2027 Language Specification
# sec-iterator-objects

Browser-Kompatibilität

Siehe auch

⌂ 换网址