Array.prototype.includes()

Probieren Sie es aus

const array = [1, 2, 3];

console.log(array.includes(2));
// Expected output: true

const pets = ["cat", "dog", "bat"];

console.log(pets.includes("cat"));
// Expected output: true

console.log(pets.includes("at"));
// Expected output: false

Syntax

includes(searchElement)
includes(searchElement, fromIndex)

Parameter

searchElement

Der zu suchende Wert.

fromIndex Optional

Der nullbasierte Index, bei dem die Suche beginnen soll, in einen ganzzahligen Wert umgewandelt.

• Ein negativer Index zhlt vom Ende des Arrays zurck wenn -array.length <= fromIndex < 0, wird fromIndex + array.length verwendet. Das Array wird jedoch in diesem Fall weiterhin von vorne nach hinten durchsucht.
• Wenn fromIndex < -array.length oder fromIndex ausgelassen wird, wird 0 verwendet, wodurch das gesamte Array durchsucht wird.
• Wenn fromIndex >= array.length, wird das Array nicht durchsucht und false wird zurckgegeben.

Rckgabewert

Ein boolescher Wert, der true ist, wenn der Wert searchElement im Array gefunden wird (oder im Teil des Arrays, der durch den Index fromIndex angegeben wird, falls spezifiziert).

Beschreibung

Die includes()-Methode vergleicht searchElement mit den Elementen des Arrays unter Verwendung des SameValueZero-Algorithmus. Dieser Algorithmus funktioniert wie die strikte Gleichheit === (wobei -0 und +0 als gleich betrachtet werden), mit der Ausnahme, dass NaN als gleich zu sich selbst betrachtet wird.

Wenn die Methode auf dnn besetzte Arrays angewendet wird, iteriert die includes()-Methode leere Stellen, als ob sie den Wert undefined htten.

Die includes()-Methode ist generisch. Sie erwartet nur, dass der this-Wert eine Eigenschaft length und integerbasiert 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 grer oder gleich der Array-Lnge

Wenn fromIndex grer oder gleich der Lnge des Arrays ist, wird false zurckgegeben. Das Array wird nicht durchsucht.

const arr = ["a", "b", "c"];

arr.includes("c", 3); // false
arr.includes("c", 100); // false

Berechneter Index ist kleiner als 0

Wenn fromIndex negativ ist, wird der berechnete Index verwendet, um eine Position im Array festzulegen, bei der die Suche nach searchElement beginnt. Wenn der berechnete Index kleiner oder gleich 0 ist, wird das gesamte Array durchsucht.

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

Verwendung von includes() bei dnn besetzten Arrays

Man kann nach undefined in einem dnn besetzten Array suchen und true erhalten.

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

Aufruf von includes() bei Nicht-Array-Objekten

Die includes()-Methode liest die length-Eigenschaft von this und greift dann auf jede Eigenschaft zu, deren Schlssel ein nicht-negativer Ganzzahlwert ist, der kleiner als length 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));
// true
console.log(Array.prototype.includes.call(arrayLike, 1));
// false

Spezifikationen

Browser-Kompatibilitt

Siehe auch

• Polyfill von Array.prototype.includes in core-js
• es-shims Polyfill von Array.prototype.includes
• Leitfaden fr indizierte Sammlungen
• Array
• Array.prototype.indexOf()
• Array.prototype.find()
• Array.prototype.findIndex()
• TypedArray.prototype.includes()
• String.prototype.includes()