Iterator

Beschreibung

Die folgenden sind alle eingebauten JavaScript-Iteratoren:

• Der Array-Iterator, der von Array.prototype.values(), Array.prototype.keys(), Array.prototype.entries(), Array.prototype[Symbol.iterator](), TypedArray.prototype.values(), TypedArray.prototype.keys(), TypedArray.prototype.entries(), TypedArray.prototype[Symbol.iterator](), und arguments[Symbol.iterator]() zurückgegeben wird.
• Der String-Iterator, der von String.prototype[Symbol.iterator]() zurückgegeben wird.
• Der Map-Iterator, der von Map.prototype.values(), Map.prototype.keys(), Map.prototype.entries(), und Map.prototype[Symbol.iterator]() zurückgegeben wird.
• Der Set-Iterator, der von Set.prototype.values(), Set.prototype.keys(), Set.prototype.entries(), und Set.prototype[Symbol.iterator]() zurückgegeben wird.
• Der RegExp-String-Iterator, der von RegExp.prototype[Symbol.matchAll]() und String.prototype.matchAll() zurückgegeben wird.
• Das Generator-Objekt, das von Generator-Funktionen zurückgegeben wird.
• Der Segments-Iterator, der von der [Symbol.iterator]()-Methode des Segments-Objekts, das von Intl.Segmenter.prototype.segment() zurückgegeben wird.
• Der Iterator Helper, der von Iterator-Hilfsmethoden wie Iterator.prototype.filter() und Iterator.prototype.map() zurückgegeben wird.

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

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

Jeder dieser Iteratoren hat ein eigenes Prototyp-Objekt, das die next()-Methode definiert, die von dem spezifischen Iterator verwendet wird. Beispielsweise erben alle String-Iterator-Objekte von einem versteckten Objekt StringIteratorPrototype, das eine next()-Methode hat, die diesen String durch Codepunkte iteriert. StringIteratorPrototype hat auch eine [Symbol.toStringTag]-Eigenschaft, deren Anfangswert der String "String Iterator" ist. Diese Eigenschaft wird in Object.prototype.toString() verwendet. Ebenso haben andere Iterator-Prototypen auch ihre eigenen [Symbol.toStringTag]-Werte, die den oben gegebenen Namen entsprechen.

Alle diese Prototyp-Objekte erben von Iterator.prototype, das eine [Symbol.iterator]()-Methode bereitstellt, die das Iterator-Objekt selbst zurückgibt, wodurch der Iterator ebenfalls iterierbar wird.

Iterator-Hilfsmethoden

Die Iterator-Klasse selbst bietet einige Hilfsmethoden für die Arbeit mit Iteratoren. Zum Beispiel könnten Sie versucht sein, Folgendes zu tun:

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

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

Dies konvertiert zuerst den Iterator, der von Map.prototype.values() zurückgegeben wird, in ein Array und verwendet dann die Methode Array.prototype.reduce(), um die Summe zu berechnen. Dies erzeugt jedoch sowohl ein Zwischenarray als auch iteriert das Array zweimal. Stattdessen können Sie die reduce()-Methode des Iterators selbst verwenden:

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

Diese Methode könnte effizienter sein, insbesondere speicherbezogen, da sie den Iterator nur einmal iteriert, ohne Zwischenwerte zu speichern. Iterator-Hilfsmethoden sind notwendig, um mit unendlichen Iteratoren zu arbeiten:

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 konvertieren, da es unendlich ist. Stattdessen können Sie die find()-Methode des Iterators selbst verwenden, die seq nur so weit iteriert, wie es notwendig ist, um den ersten Wert zu finden, der die Bedingung erfüllt.

Sie werden viele Iterator-Methoden finden, die analog zu Array-Methoden sind, wie zum Beispiel:

Iterator.prototype.drop() und Iterator.prototype.take() kombiniert sind in gewisser Hinsicht analog zu Array.prototype.slice().

Iterator-Hilfeobjekte

Unter den Iterator-Hilfsmethoden geben filter(), flatMap(), map(), drop(), und take() ein neues Iterator-Hilfeobjekt zurück. Der Iterator-Helfer ist ebenfalls eine Iterator-Instanz, wodurch diese Hilfsmethoden verkettbar sind. Alle Iterator-Hilfeobjekte erben von einem gemeinsamen Prototyp-Objekt, 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.

Der Iterator-Helfer teilt die gleiche Datenquelle wie der zugrunde liegende Iterator, sodass das Iterieren des Iterator-Helfers auch dazu führt, dass der zugrunde liegende Iterator iteriert wird. Es gibt keine Möglichkeit, einen Iterator zu "verzweigen", um ihn mehrmals zu iterieren.

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

Richtige Iteratoren

Es gibt zwei Arten von "Iteratoren": Objekte, die dem Iterator-Protokoll entsprechen (was im Minimalen nur die Anwesenheit einer next()-Methode erfordert), und Objekte, die von der Iterator-Klasse erben, welche die Hilfsmethoden nutzen. Sie bedingen sich nicht gegenseitig — Objekte, die von Iterator erben, werden nicht automatisch zu Iteratoren, da die Iterator-Klasse keine next()-Methode definiert. Stattdessen muss das Objekt selbst eine next()-Methode definieren. Ein richtiger Iterator ist einer, der sowohl dem Iterator-Protokoll entspricht als auch von Iterator erbt, und die meisten Codes erwarten, dass Iteratoren richtige Iteratoren sind und Iterables richtige Iteratoren zurückgeben. Um richtige Iteratoren zu erstellen, definieren Sie eine Klasse, die von Iterator erweitert, oder verwenden Sie die Methode Iterator.from().

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

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

Konstruktor

Iterator()

Soll erweitert werden von anderen Klassen, die Iteratoren erstellen. Wirft einen Fehler, wenn sie selbst erstellt wird.

Statische Methoden

Iterator.concat()

Erstellt ein neues Iterator-Objekt aus einer Liste iterierbarer Objekte. Der neue Iterator liefert die Werte aus jedem der Eingabe-Iterables der Reihe nach.

Iterator.from()

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

Iterator.zip()

Erstellt ein neues Iterator-Objekt, das Elemente aus mehreren iterierbaren Objekten aggregiert, indem es Arrays mit Elementen an derselben Position liefert.

Iterator.zipKeyed()

Erstellt ein neues Iterator-Objekt, das Elemente aus mehreren iterierbaren Objekten aggregiert, indem es Objekte mit Elementen an derselben Position liefert, wobei die Schlüssel durch die Eingabe spezifiziert werden.

Instanz-Eigenschaften

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

Iterator.prototype.constructor

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

Iterator.prototype[Symbol.toStringTag]

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

Hinweis: Im Gegensatz zu dem [Symbol.toStringTag] bei den meisten eingebauten Klassen ist Iterator.prototype[Symbol.toStringTag] beschreibbar aus Gründen der Web-Kompatibilität.

Instanz-Methoden

Iterator.prototype.chunks()

Gibt ein neues Iterator-Hilfeobjekt zurück, das die Elemente des ursprünglichen Iterators in aufeinanderfolgende Arrays aufteilt. Jedes Mal, wenn der Helfer iteriert wird, erhält er die angegebene Anzahl von Elementen vom zugrunde liegenden Iterator und gibt sie gemeinsam zurück.

Iterator.prototype.drop()

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

Iterator.prototype.every()

Gibt false zurück, wenn es ein Element findet, das die bereitgestellte Testfunktion nicht erfüllt. Andernfalls, wenn der Iterator erschöpft ist, ohne ein solches Element zu finden, gibt er true zurück.

Iterator.prototype.filter()

Gibt ein neues Iterator-Hilfeobjekt 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 produzierte Element zurück, das die bereitgestellte Testfunktion erfüllt. Wenn keine Werte die Testfunktion erfüllen, wird undefined zurückgegeben.

Iterator.prototype.flatMap()

Gibt ein neues Iterator-Hilfeobjekt zurück, das jedes Element im ursprünglichen Iterator nimmt, es durch eine Mapping-Funktion laufen lässt und die Elemente liefert, die von der Mapping-Funktion zurückgegeben werden (die in einem anderen Iterator oder Iterable enthalten sind).

Iterator.prototype.forEach()

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

Iterator.prototype.includes()

Gibt true zurück, wenn ein vom Iterator produziertes Element gleich dem gegebenen Wert ist. Andernfalls, wenn der Iterator erschöpft ist, ohne ein solches Element zu finden, gibt er false zurück.

Iterator.prototype.join()

Gibt einen String zurück, der die Verkettung aller vom Iterator produzierten Elemente darstellt, getrennt durch Kommas oder einen angegebenen Trennzeichen-String.

Iterator.prototype.map()

Gibt ein neues Iterator-Hilfeobjekt zurück, das Elemente des Iterators liefert, wobei jedes durch eine Mapping-Funktion transformiert wird.

Iterator.prototype.reduce()

Führt eine benutzerdefinierte "Reducer"-Callback-Funktion auf jedem vom Iterator produzierten Element aus, wobei der Rückgabewert der Berechnung auf das vorherige Element übergeben wird. Das Endergebnis der Ausführung des Reducers über alle Elemente ist ein einzelner Wert.

Iterator.prototype.some()

Gibt true zurück, wenn es ein Element findet, das die bereitgestellte Testfunktion erfüllt. Andernfalls, wenn der Iterator erschöpft ist, ohne ein solches Element zu finden, gibt er false zurück.

Iterator.prototype.take()

Gibt ein neues Iterator-Hilfeobjekt zurück, das die angegebene Anzahl von Elementen in diesem Iterator liefert und dann beendet.

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-Hilfeobjekt zurück, das ein gleitendes Fenster von Elementen liefert. Jedes Mal, wenn der Helfer iteriert wird, liefert er ein Array, das das erste Element aus der vorherigen Iteration entfernt und das nächste Element aus dem ursprünglichen Iterator hinzufügt.

Iterator.prototype[Symbol.dispose]()

Ruft die return()-Methode von this auf, falls sie existiert. Dies implementiert das disposable-Protokoll und ermöglicht es, es zu entsorgen, wenn es mit using oder await using verwendet wird.

Iterator.prototype[Symbol.iterator]()

Gibt das Iterator-Objekt selbst zurück. Dies ermöglicht es, dass Iterator-Objekte ebenfalls iterierbar sind.

Beispiele

Verwenden eines Iterators als Iterierbares

Alle eingebauten Iteratoren sind ebenfalls iterierbar, sodass Sie sie in einer for...of-Schleife verwenden können:

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

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Polyfill von Iterator in core-js
• es-shims Polyfill von Iterator und zugehörigen Hilfsmitteln
• function*
• Iterationsprotokolle