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 dafür vorgesehen, als Superklasse anderer Klassen verwendet zu werden, die Iteratoren erstellen. Er erzeugt 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. Darüber hinaus kann Iterator() nicht tatsächlich selbst konstruiert werden – er wird normalerweise implizit durch Aufrufe von super() 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 allgemeine Utilities für ihre Unterklassen bereitstellt, aber nicht selbst instanziiert werden soll. Es ist die Superklasse aller anderen Iterator-Klassen und wird verwendet, um Unterklassen zu erstellen, die spezifische Iterationsalgorithmen implementieren – nämlich müssen alle Unterklassen von Iterator eine next()-Methode implementieren, wie es das Iterator-Protokoll erfordert. 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 bereits vorhandenen iterierbaren oder Iterator-Objekt zu erstellen.

Beispiele

Subclassing von Iterator

Das folgende Beispiel definiert eine benutzerdefinierte Datenstruktur, Range, die Iteration ermöglicht. 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);
}

Das funktioniert, ist aber nicht so elegant wie bei eingebauten Iteratoren. Es gibt zwei Probleme:

  • Der zurückgegebene Iterator erbt von Generator, was bedeutet, dass Änderungen an Generator.prototype den zurückgegebenen Iterator beeinflussen, was ein Abstraktionsleck darstellt.
  • Der zurückgegebene Iterator erbt nicht von einem benutzerdefinierten Prototyp, was es erschwert, wenn wir beabsichtigen, dem Iterator zusätzliche Methoden hinzuzufügen.

Wir können die Implementierung eingebauter Iteratoren, wie map iterators, nachahmen, indem wir Iterator unterklassen. Dies ermöglicht es uns, zusätzliche Eigenschaften zu definieren, wie [Symbol.toStringTag], wobei die Iterator-Hilfsmethoden für den 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 iterierbares oder Iterator-Objekt haben, das nicht von Iterator erbt und Sie nur Iterator-Hilfsmethoden darauf aufrufen möchten, können Sie Iterator.from() verwenden, um eine einmalige Iterator-Instanz zu erstellen.

Spezifikationen

Specification
Iterator Helpers
# sec-iterator-constructor

Browser-Kompatibilität

Siehe auch