Symbol.iterator

Probieren Sie es aus

const iterable = {};

iterable[Symbol.iterator] = function* () {
  yield 1;
  yield 2;
  yield 3;
};

console.log([...iterable]);
// Expected output: Array [1, 2, 3]

Wert

Das wohlbekannte Symbol Symbol.iterator.

Beschreibung

Immer wenn ein Objekt iteriert werden muss (wie zu Beginn einer for...of Schleife), wird seine Methode [Symbol.iterator]() ohne Argumente aufgerufen, und der zurückgegebene Iterator wird verwendet, um die zu iterierenden Werte zu erhalten.

Einige eingebaute Typen haben ein Standardverhalten für die Iteration, während andere Typen (wie Object) dies nicht haben. Einige eingebaute Typen mit einer [Symbol.iterator]()-Methode sind:

• Array.prototype[Symbol.iterator]()
• TypedArray.prototype[Symbol.iterator]()
• String.prototype[Symbol.iterator]()
• Map.prototype[Symbol.iterator]()
• Set.prototype[Symbol.iterator]()

Siehe auch Iterationsprotokolle für weitere Informationen.

Beispiele

Benutzerdefinierte Iterables

Wir können unsere eigenen Iterables wie folgt erstellen:

const myIterable = {};
myIterable[Symbol.iterator] = function* () {
  yield 1;
  yield 2;
  yield 3;
};
[...myIterable]; // [1, 2, 3]

Oder Iterables können direkt innerhalb einer Klasse oder eines Objekts unter Verwendung einer berechneten Eigenschaft definiert werden:

class Foo {
  *[Symbol.iterator]() {
    yield 1;
    yield 2;
    yield 3;
  }
}

const someObj = {
  *[Symbol.iterator]() {
    yield "a";
    yield "b";
  },
};

console.log(...new Foo()); // 1, 2, 3
console.log(...someObj); // 'a', 'b'

Nicht wohlgeformte Iterables

Wenn die [Symbol.iterator]()-Methode eines Iterables kein Iterator-Objekt zurückgibt, ist es ein nicht wohlgeformtes Iterable. Die Verwendung dessen wird wahrscheinlich zu Laufzeitausnahmen oder fehlerhaftem Verhalten führen:

const nonWellFormedIterable = {};
nonWellFormedIterable[Symbol.iterator] = () => 1;
[...nonWellFormedIterable]; // TypeError: [Symbol.iterator]() returned a non-object value

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Polyfill von Symbol.iterator in core-js
• Iterationsprotokolle
• Array.prototype[Symbol.iterator]()
• TypedArray.prototype[Symbol.iterator]()
• String.prototype[Symbol.iterator]()
• Map.prototype[Symbol.iterator]()
• Set.prototype[Symbol.iterator]()
• arguments[Symbol.iterator]()
• Segments.prototype[Symbol.iterator]()