Iterator() Konstruktor

Baseline 2025
Newly available

Since March 2025, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

Der Iterator() Konstruktor ist dazu gedacht, als Oberklasse anderer Klassen verwendet zu werden, die Iteratoren erstellen. Er wirft einen Fehler, wenn er selbst konstruiert wird.

Syntax

js
new Iterator()

Hinweis: Iterator() kann nur mit new konstruiert werden. Der Versuch, ihn ohne new aufzurufen, führt zu einem TypeError. Außerdem kann Iterator() nicht tatsächlich selbst konstruiert werden — er wird normalerweise implizit durch super() Aufrufe innerhalb des Konstruktors einer Unterklasse konstruiert.

Parameter

Keine.

Rückgabewert

Ein neues Iterator Objekt.

Ausnahmen

TypeError

Wenn new.target die Iterator Funktion selbst ist, d.h. wenn der Iterator Konstruktor selbst konstruiert wird.

Beschreibung

Iterator repräsentiert eine abstrakte Klasse — eine Klasse, die gemeinsame Utilities für ihre Unterklassen bereitstellt, aber selbst nicht instanziiert werden soll. Sie ist die Oberklasse aller anderen Iterator-Klassen und wird verwendet, um Unterklassen zu erstellen, die spezifische Iterationsalgorithmen implementieren — das heißt, alle Unterklassen von Iterator müssen eine next() Methode gemäß dem Iterator-Protokoll implementieren. Da Iterator die next() Methode nicht tatsächlich bereitstellt, macht es keinen Sinn, einen Iterator direkt zu konstruieren.

Sie können auch Iterator.from() verwenden, um eine Iterator Instanz aus einem vorhandenen Iterable oder Iterator-Objekt zu erstellen.

Beispiele

Subclassen von Iterator

Das folgende Beispiel definiert eine benutzerdefinierte Datenstruktur, Range, die Iteration erlaubt. Um ein Objekt iterierbar zu machen, können wir eine [Symbol.iterator]() Methode in Form einer Generatorfunktion bereitstellen:

js
class Range {
  #start;
  #end;
  #step;

  constructor(start, end, step = 1) {
    this.#start = start;
    this.#end = end;
    this.#step = step;
  }

  *[Symbol.iterator]() {
    for (let value = this.#start; value <= this.#end; value += this.#step) {
      yield value;
    }
  }
}

const range = new Range(1, 5);
for (const num of range) {
  console.log(num);
}

Dies funktioniert, ist aber nicht so elegant, wie eingebaute Iteratoren. Es gibt zwei Probleme:

  • Der zurückgegebene Iterator erbt von Generator, was bedeutet, dass Änderungen an Generator.prototype den zurückgegebenen Iterator beeinflussen könnten, was eine Abstraktionsleckage darstellt.
  • Der zurückgegebene Iterator erbt nicht von einem benutzerdefinierten Prototyp, was es schwieriger macht, wenn wir beabsichtigen, dem Iterator zusätzliche Methoden hinzuzufügen.

Wir können die Implementierung eingebauter Iteratoren, wie Karten-Iteratoren, nachahmen, indem wir von Iterator ableiten. Dies ermöglicht es uns, zusätzliche Eigenschaften zu definieren, wie zum Beispiel [Symbol.toStringTag], während die Iterator-Hilfsmethoden im zurückgegebenen Iterator verfügbar gemacht werden.

js
class Range {
  #start;
  #end;
  #step;

  constructor(start, end, step = 1) {
    this.#start = start;
    this.#end = end;
    this.#step = step;
  }

  static #RangeIterator = class extends Iterator {
    #cur;
    #s;
    #e;
    constructor(range) {
      super();
      this.#cur = range.#start;
      this.#s = range.#step;
      this.#e = range.#end;
    }
    static {
      Object.defineProperty(this.prototype, Symbol.toStringTag, {
        value: "Range Iterator",
        configurable: true,
        enumerable: false,
        writable: false,
      });

      // Avoid #RangeIterator from being accessible outside
      delete this.prototype.constructor;
    }
    next() {
      if (this.#cur > this.#e) {
        return { value: undefined, done: true };
      }
      const res = { value: this.#cur, done: false };
      this.#cur += this.#s;
      return res;
    }
  };

  [Symbol.iterator]() {
    return new Range.#RangeIterator(this);
  }
}

const range = new Range(1, 5);
for (const num of range) {
  console.log(num);
}

Das Subclassing-Muster ist nützlich, wenn Sie viele benutzerdefinierte Iteratoren erstellen möchten. Wenn Sie ein vorhandenes Iterable oder ein Iterator-Objekt haben, das nicht von Iterator erbt, und Sie einfach Iterator-Hilfsmethoden darauf aufrufen möchten, können Sie Iterator.from() verwenden, um eine einmalige Iterator-Instanz zu erstellen.

Spezifikationen

Specification
ECMAScript® 2026 Language Specification
# sec-iterator-constructor

Browser-Kompatibilität

Siehe auch