Signatur
includes(searchElement) / includes(searchElement, fromIndex)
Beschreibung
Die Methode includes() von Array-Instanzen ermittelt, ob ein Array einen bestimmten Wert unter seinen Einträgen enthält, und gibt entsprechend true oder false zurück.
Die Methode includes() vergleicht searchElement mit den Elementen des Arrays mithilfe des SameValueZero-Algorithmus. Dieser Algorithmus funktioniert wie der strikte Gleichheitsvergleich === (wobei -0 und +0 als gleich betrachtet werden), mit der Ausnahme, dass NaN als gleich zu sich selbst betrachtet wird.
Bei Anwendung auf sparse Arrays iteriert die Methode includes() leere Slots so, als ob sie den Wert undefined hätten.
Die Methode includes() ist generisch. Sie erwartet nur, dass der this-Wert eine length-Eigenschaft und ganzzahlig indizierte Eigenschaften hat.
Parameter
| Name | Typ | Default | Beschreibung |
|---|---|---|---|
| $searchElement Pflicht | any | — | Der Wert, nach dem gesucht werden soll. |
| $fromIndex | number | — | Nullbasierter Index, bei dem die Suche beginnen soll, konvertiert zu einer Ganzzahl. Ein negativer Index zählt vom Ende des Arrays zurück — wenn -array.length <= fromIndex < 0, wird fromIndex + array.length verwendet. In diesem Fall wird das Array jedoch weiterhin von vorne nach hinten durchsucht. Wenn fromIndex < -array.length oder fromIndex weggelassen wird, wird 0 verwendet, wodurch das gesamte Array durchsucht wird. Wenn fromIndex >= array.length, wird das Array nicht durchsucht und false zurückgegeben. |
Rückgabewert
Typ
boolean
Beschreibung
Ein boolescher Wert, der
true ist, wenn der Wert searchElement innerhalb des Arrays (oder des durch den Index fromIndex angegebenen Teils des Arrays, falls angegeben) gefunden wird.Beispiele
Verwendung von includes()
[1, 2, 3].includes(2); // true
[1, 2, 3].includes(4); // false
[1, 2, 3].includes(3, 3); // false
[1, 2, 3].includes(3, -1); // true
[1, 2, NaN].includes(NaN); // true
["1", "2", "3"].includes(3); // falsefromIndex ist größer als oder gleich der Array-Länge
const arr = ["a", "b", "c"];
arr.includes("c", 3); // false
arr.includes("c", 100); // falseBerechneter Index ist kleiner als 0
// array length is 3
// fromIndex is -100
// computed index is 3 + (-100) = -97
const arr = ["a", "b", "c"];
arr.includes("a", -100); // true
arr.includes("b", -100); // true
arr.includes("c", -100); // true
arr.includes("a", -2); // falseVerwendung von includes() auf sparse Arrays
console.log([1, , 3].includes(undefined)); // trueAufruf von includes() auf Nicht-Array-Objekten
const arrayLike = {
length: 3,
0: 2,
1: 3,
2: 4,
3: 1, // von includes() ignoriert, da length 3 ist
};
console.log(Array.prototype.includes.call(arrayLike, 2));
// true
console.log(Array.prototype.includes.call(arrayLike, 1));
// false