Iterator() Konstruktor

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Der Iterator() Konstruktor soll als Superklasse anderer Klassen verwendet werden, die Iteratoren erstellen. Er löst einen Fehler aus, wenn er selbstständig konstruiert wird.

Syntax

js
new Iterator()

Note: Iterator() kann nur mit new konstruiert werden. Der Versuch, ihn ohne new aufzurufen, löst einen TypeError aus. Außerdem kann der Iterator() eigentlich nicht 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 Funktionen 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 vorhandenen Iterable oder Iterator-Objekt zu erstellen.

Beispiele

Subklassierung von Iterator

Im folgenden Beispiel wird eine benutzerdefinierte Datenstruktur Range definiert, die die Iteration ermöglicht. Um ein Objekt iterierbar zu machen, können wir eine [Symbol.iterator]()-Methode in Form einer Generator-Funktion 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 die Funktionsweise von eingebauten Iteratoren. Es gibt zwei Probleme:

  • Der zurückgegebene Iterator erbt von Generator, was bedeutet, dass Änderungen an Generator.prototype den zurückgegebenen Iterator betreffen, was ein Durchbruch der Abstraktion ist.
  • Der zurückgegebene Iterator erbt nicht von einem benutzerdefinierten Prototyp, was es schwieriger macht, wenn wir beabsichtigen, zusätzliche Methoden zum Iterator hinzuzufügen.

Wir können die Implementierung von eingebauten Iteratoren, wie z.B. Karten-Iteratoren, nachahmen, indem wir Iterator subklassieren. Dies ermöglicht es uns, zusätzliche Eigenschaften zu definieren, wie zum Beispiel [Symbol.toStringTag], während die Iterator-Hilfsmethoden auf dem zurückgegebenen Iterator verfügbar sind.

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 Subklassierungsmuster ist nützlich, wenn Sie viele benutzerdefinierte Iteratoren erstellen möchten. Wenn Sie ein vorhandenes Iterable oder 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
Iterator Helpers
# sec-iterator-constructor

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch