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 bekannte Symbol Symbol.iterator.

Beschreibung

Immer wenn ber ein Objekt iteriert werden soll (beispielsweise zu Beginn einer for...of-Schleife), wird seine Methode [Symbol.iterator]() ohne Argumente aufgerufen. Der zurckgegebene Iterator wird verwendet, um die Werte fr die Iteration abzurufen.

Einige integrierte Typen haben ein Standardverhalten fr die Iteration, andere Typen (wie Object) hingegen nicht. Zu den integrierten Typen mit einer Methode [Symbol.iterator]() gehren:

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

Weitere Informationen finden Sie unter Iterationsprotokolle.

Beispiele

Benutzerdefinierte iterierbare Objekte

Sie knnen eigene iterierbare Objekte wie folgt erstellen:

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

Alternativ knnen iterierbare Objekte mithilfe einer berechneten Eigenschaft direkt innerhalb einer Klasse oder eines Objekts 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 iterierbare Objekte

Wenn die Methode [Symbol.iterator]() eines iterierbaren Objekts kein Iteratorobjekt zurckgibt, ist das iterierbare Objekt nicht wohlgeformt. Seine Verwendung als iterierbares Objekt fhrt wahrscheinlich zu Laufzeitausnahmen oder fehlerhaftem Verhalten:

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

Spezifikationen

Browser-Kompatibilitt

Siehe auch

• Polyfill fr 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]()