Dieincludes() Methode vonArray Instanzen bestimmt, ob ein Array einen bestimmten Wert unter seinen Einträgen enthält und gibt entsprechendtrue oderfalse zurück.

Probieren Sie es aus

const array = [1, 2, 3];console.log(array.includes(2));// Expected output: trueconst pets = ["cat", "dog", "bat"];console.log(pets.includes("cat"));// Expected output: trueconsole.log(pets.includes("at"));// Expected output: false

Syntax

includes(searchElement)includes(searchElement, fromIndex)

Parameter

searchElement

Der zu suchende Wert.

fromIndexOptional

Nullbasierter Index, ab dem die Suche gestartet wird,in eine ganze Zahl umgewandelt.

• Ein negativer Index zählt vom Ende des Arrays zurück — wenn-array.length <= fromIndex < 0, wirdfromIndex + array.length verwendet. In diesem Fall wird das Array jedoch weiterhin von vorne nach hinten durchsucht.
• WennfromIndex < -array.length ist oderfromIndex weggelassen wird, wird0 verwendet, wodurch das gesamte Array durchsucht wird.
• WennfromIndex >= array.length ist, wird das Array nicht durchsucht undfalse wird zurückgegeben.

Rückgabewert

Ein Boolean-Wert, dertrue ist, wenn der WertsearchElement innerhalb des Arrays (oder dem durch den IndexfromIndex angegebenen Teil des Arrays, falls angegeben) gefunden wird.

Beschreibung

Dieincludes() Methode vergleichtsearchElement mit den Elementen des Arrays unter Verwendung desSameValueZero Algorithmus. Nullwerte werden unabhängig vom Vorzeichen als gleich betrachtet (das heißt,-0 ist gleich0), aberfalse wirdnicht als gleich0 angesehen.NaN kann korrekt durchsucht werden.

Bei Verwendung aufsparsely besetzten Arrays iteriert dieincludes() Methode leere Plätze, als hätten sie den Wertundefined.

Dieincludes() Methode istgenerisch. Sie erwartet nur, dass derthis Wert einelength Eigenschaft und integer-basierte Eigenschaften hat.

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); // false

fromIndex ist größer oder gleich der Array-Länge

WennfromIndex größer oder gleich der Länge des Arrays ist, wirdfalse zurückgegeben. Das Array wird nicht durchsucht.

const arr = ["a", "b", "c"];arr.includes("c", 3); // falsearr.includes("c", 100); // false

Berechneter Index ist kleiner als 0

WennfromIndex negativ ist, wird der berechnete Index berechnet, um als Position im Array verwendet zu werden, an der die Suche nachsearchElement beginnt. Wenn der berechnete Index kleiner oder gleich0 ist, wird das gesamte Array durchsucht.

// array length is 3// fromIndex is -100// computed index is 3 + (-100) = -97const arr = ["a", "b", "c"];arr.includes("a", -100); // truearr.includes("b", -100); // truearr.includes("c", -100); // truearr.includes("a", -2); // false

Verwendung von includes() bei sporadischen Arrays

Sie können nachundefined in einem sporadischen Array suchen undtrue erhalten.

console.log([1, , 3].includes(undefined)); // true

Nutzung von includes() bei Nicht-Array-Objekten

Dieincludes() Methode liest dielength Eigenschaft vonthis und greift dann auf jede Eigenschaft zu, deren Schlüssel eine nichtnegative ganze Zahl kleiner alslength ist.

const arrayLike = {  length: 3,  0: 2,  1: 3,  2: 4,  3: 1, // ignored by includes() since length is 3};console.log(Array.prototype.includes.call(arrayLike, 2));// trueconsole.log(Array.prototype.includes.call(arrayLike, 1));// false

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Polyfill vonArray.prototype.includes incore-js
• es-shims Polyfill vonArray.prototype.includes
• Leitfaden zu indizierten Sammlungen
• Array
• Array.prototype.indexOf()
• Array.prototype.find()
• Array.prototype.findIndex()
• TypedArray.prototype.includes()
• String.prototype.includes()