Start · Sprachen · JavaScript · Referenz · String.prototype.includes()

String.prototype.includes()

Methode

Die Methode <code>includes()</code> von <code>String</code>-Werten führt eine Suche unter Beachtung der Groß-/Kleinschreibung durch und liefert <code>true</code> oder <code>false</code>.

Kategorie: method-property

Signatur

includes(searchString) / includes(searchString, position)

Beschreibung

Diese Methode ermöglicht es festzustellen, ob ein String einen anderen String enthält oder nicht.

Groß-/Kleinschreibung

Die Methode includes() unterscheidet zwischen Groß- und Kleinschreibung. Beispielsweise liefert der folgende Ausdruck false:

"Blue Whale".includes("blue"); // returns false

Sie können diese Einschränkung umgehen, indem Sie sowohl den ursprünglichen String als auch den Such-String in Kleinbuchstaben umwandeln:

"Blue Whale".toLowerCase().includes("blue"); // returns true

Parameter

Name Typ Default Beschreibung
$searchString Pflicht string Ein String, nach dem innerhalb von str gesucht werden soll. Darf kein regex sein. Alle Werte, die keine regexes sind, werden zu Strings konvertiert. Wird der Parameter weggelassen oder undefined übergeben, sucht includes() nach dem String "undefined", was selten das gewünschte Verhalten ist.
$position number 0 Die Position innerhalb des Strings, ab der mit der Suche nach searchString begonnen werden soll.

Rückgabewert

Typ
boolean
Beschreibung
true, wenn der Such-String irgendwo innerhalb des gegebenen Strings gefunden wird, auch wenn searchString ein leerer String ist; andernfalls false.

Beispiele

Verwendung von includes()

const str = "To be, or not to be, that is the question.";

console.log(str.includes("To be")); // true
console.log(str.includes("question")); // true
console.log(str.includes("nonexistent")); // false
console.log(str.includes("To be", 1)); // false
console.log(str.includes("TO BE")); // false
console.log(str.includes("")); // true

// Wichtig · Fallstricke

Wird ein TypeError geworfen, wenn searchString ein regex ist.