Iterator.prototype.includes()

Syntax

includes(searchElement)
includes(searchElement, fromIndex)

Parameter

searchElement

Der Wert, nach dem gesucht werden soll.

fromIndex Optional

Der nullbasierte Index, ab dem gesucht werden soll. Muss eine nicht negative Ganzzahl, Infinity oder undefined sein. Wenn fromIndex größer oder gleich der Anzahl der vom Iterator erzeugten Elemente ist (auch wenn fromIndex gleich Infinity ist), gibt die Methode nach dem vollständigen Durchlaufen des Iterators immer false zurück. Wenn fromIndex gleich undefined ist, wird standardmäßig 0 verwendet.

Rückgabewert

Ein boolescher Wert, der true ist, wenn der Wert searchElement im Iterator gefunden wird (oder, falls angegeben, in dem bei fromIndex beginnenden Teil des Iterators).

Ausnahmen

TypeError

Wird ausgelöst, wenn fromIndex weder eine Ganzzahl noch Infinity, -Infinity oder undefined ist.

RangeError

Wird ausgelöst, wenn fromIndex negativ ist.

Beschreibung

Die includes()-Methode vergleicht searchElement mit den Elementen des Iterators mithilfe des SameValueZero-Algorithmus. Dieser Algorithmus funktioniert wie die strikte Gleichheit === (bei der -0 und +0 als gleich gelten), mit der Ausnahme, dass NaN als gleich zu sich selbst gilt.

Anders als bei Array.prototype.includes() darf der Parameter fromIndex bei Iterator.prototype.includes() nicht negativ sein, da die Länge des Iterators nicht bekannt ist. Auch die Typprüfung ist strenger: Werte, die keine Ganzzahlen sind, werden nicht auf Ganzzahlen gekürzt.

Der Hauptvorteil von Iterator-Hilfsmethoden gegenüber Array-Methoden besteht darin, dass sie Werte erst bei Bedarf erzeugen. Dadurch werden unnötige Berechnungen vermieden, und sie können auch mit unendlichen Iteratoren verwendet werden. Bei unendlichen Iteratoren gibt includes() true zurück, sobald die erste Übereinstimmung gefunden wird. Wenn der Wert nie vorkommt, kehrt die Methode nie zurück.

Ein Aufruf von includes() schließt den zugrunde liegenden Iterator immer, auch wenn die Methode vorzeitig zurückkehrt. Der Iterator bleibt nie in einem nur teilweise durchlaufenen Zustand zurück.

Beispiele

includes() verwenden

function* fibonacci() {
  let current = 1;
  let next = 1;
  while (true) {
    yield current;
    [current, next] = [next, current + next];
  }
}

console.log(fibonacci().includes(8)); // true
console.log(fibonacci().take(10).includes(7)); // false
console.log(fibonacci().includes(7)); // Never completes

Die Methode schließt den Iterator, bevor sie zurückkehrt.

const seq = fibonacci();
console.log(seq.includes(8)); // true
console.log(seq.next()); // { value: undefined, done: true }

fromIndex verwenden

fromIndex gibt an, wie viele Elemente am Anfang übersprungen werden sollen. Dies entspricht dem Aufruf von drop(fromIndex).includes(searchElement).

function* fibonacci() {
  let current = 1;
  let next = 1;
  while (true) {
    yield current;
    [current, next] = [next, current + next];
  }
}

console.log(fibonacci().includes(8, 3)); // true
console.log(fibonacci().includes(8, 10)); // false

Wenn fromIndex größer oder gleich der Anzahl der verfügbaren Elemente ist, wird false zurückgegeben.

["a", "b", "c"].values().includes("a", 3); // false

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Polyfill für Iterator.prototype.includes in core-js
• Polyfill für Iterator.prototype.includes von es-shims
• Iterator
• Iterator.prototype.every()
• Iterator.prototype.find()
• Iterator.prototype.some()
• Array.prototype.includes()