Array.prototype.includes()

BaselineWidely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since August 2016.

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 array1 = [1, 2, 3];console.log(array1.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 mit der Suche begonnen wird,in einen Integer umgewandelt.

Ein negativer Index zählt vom Ende des Arrays rückwärts — wenn-array.length <= fromIndex < 0, wirdfromIndex + array.length verwendet. Das Array wird jedoch immer noch von vorne nach hinten durchsucht.
IstfromIndex < -array.length oder wirdfromIndex weggelassen, wird0 verwendet, sodass das gesamte Array durchsucht wird.
IstfromIndex >= array.length, wird das Array nicht durchsucht und es wirdfalse zurückgegeben.

Rückgabewert

Ein boolescher Wert, dertrue ist, wenn der WertsearchElement im Array gefunden wird (oder in dem durch den IndexfromIndex angegebenen Teil des Arrays, falls angegeben).

Dieincludes()-Methode vergleichtsearchElement mit den Elementen des Arrays unter Verwendung desSameValueZero-Algorithmus. Werte von Null werden unabhängig von ihrem Vorzeichen als gleich betrachtet (d.h.-0 ist gleich0), aberfalse wirdnicht als gleich0 angesehen.NaN kann korrekt gesucht werden.

Wenn sie aufdünn besetzten Arrays angewendet wird, iteriert dieincludes()-Methode leere Slots, als ob sie den Wertundefined hätten.

Dieincludes()-Methode istgenerisch. Sie erwartet nur, dass derthis-Wert einelength-Eigenschaft und Integer-indizierte 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 verwendet, um die Position im Array zu ermitteln, an der die Suche nachsearchElement beginnt. Ist der berechnete Index kleiner oder gleich0, 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

Nutzung von includes() auf dünn besetzten Arrays

Sie könnenundefined in einem dünn besetzten Array suchen undtrue zurückbekommen.

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

Aufruf von includes() auf Nicht-Array-Objekten

Dieincludes()-Methode liest dielength-Eigenschaft vonthis und greift dann auf jede Eigenschaft zu, deren Schlüssel eine nicht-negative ganze Zahl ist, die 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