RegExp.escape()

Syntax

RegExp.escape(string)

Parameter

string

Der String, der maskiert werden soll.

Rückgabewert

Ein neuer String, der sicher als literales Muster für den RegExp()-Konstruktor verwendet werden kann. Dazu werden die folgenden Bestandteile des Eingabestrings ersetzt:

• Das erste Zeichen des Strings wird, falls es eine Dezimalziffer (0–9) oder ein ASCII-Buchstabe (a–z, A–Z) ist, mit der \x-Zeichen-Escape-Syntax maskiert. Beispielsweise gibt RegExp.escape("foo") "\\x66oo" zurück (hier und im Folgenden stehen die beiden Backslashes in einem String-Literal für ein einzelnes Backslash-Zeichen). Dadurch wird verhindert, dass das erste Zeichen als Teil einer Escape-Sequenz interpretiert wird, wenn der maskierte String in ein größeres Muster eingebettet wird und unmittelbar auf \1, \x0, \u000 usw. folgt.
• Regex-Syntaxzeichen, darunter ^, $, \, ., *, +, ?, (, ), [, ], {, } und |, sowie das Trennzeichen / werden maskiert, indem ihnen ein \ vorangestellt wird. Beispielsweise gibt RegExp.escape("foo.bar") "\\x66oo\\.bar" zurück und RegExp.escape("(foo)") gibt "\\(foo\\)" zurück.
• Andere Satzzeichen, darunter ,, -, =, <, >, #, &, !, %, :, ;, @, ~, ', ` und ", werden mit der \x-Syntax maskiert. Beispielsweise gibt RegExp.escape("foo-bar") "\\x66oo\\x2dbar" zurück. Diese Zeichen können nicht durch ein vorangestelltes \ maskiert werden, da beispielsweise /foo\-bar/u ein Syntaxfehler ist.
• Zeichen mit eigenen Zeichen-Escape-Sequenzen – \f (U+000C FORM FEED), \n (U+000A LINE FEED), \r (U+000D CARRIAGE RETURN), \t (U+0009 CHARACTER TABULATION) und \v (U+000B LINE TABULATION) – werden durch ihre Escape-Sequenzen ersetzt. Beispielsweise gibt RegExp.escape("foo\nbar") "\\x66oo\\nbar" zurück.
• Das Leerzeichen wird als "\\x20" maskiert.
• Andere Nicht-ASCII-Zeilenumbruch- und Leerraumzeichen werden durch eine oder zwei \uXXXX-Escape-Sequenzen ersetzt, die ihre UTF-16-Codeeinheiten darstellen. Beispielsweise gibt RegExp.escape("foo\u2028bar") "\\x66oo\\u2028bar" zurück.
• Einzelne Surrogate werden durch ihre \uXXXX-Escape-Sequenzen ersetzt. Beispielsweise gibt RegExp.escape("foo\uD800bar") "\\x66oo\\ud800bar" zurück.

Ausnahmen

TypeError

Wird ausgelöst, wenn string kein String ist.

Beispiele

RegExp.escape() verwenden

Die folgenden Beispiele zeigen verschiedene Eingaben und Ausgaben der Methode RegExp.escape().

RegExp.escape("Buy it. use it. break it. fix it.");
// "\\x42uy\\x20it\\.\\x20use\\x20it\\.\\x20break\\x20it\\.\\x20fix\\x20it\\."
RegExp.escape("foo.bar"); // "\\x66oo\\.bar"
RegExp.escape("foo-bar"); // "\\x66oo\\x2dbar"
RegExp.escape("foo\nbar"); // "\\x66oo\\nbar"
RegExp.escape("foo\uD800bar"); // "\\x66oo\\ud800bar"
RegExp.escape("foo\u2028bar"); // "\\x66oo\\u2028bar"

RegExp.escape() mit dem RegExp-Konstruktor verwenden

RegExp.escape() wird hauptsächlich verwendet, wenn Sie einen String in ein größeres Regex-Muster einbetten möchten und sicherstellen wollen, dass er als literales Muster und nicht als Regex-Syntax behandelt wird. Betrachten Sie das folgende einfache Beispiel, das URLs ersetzt:

function removeDomain(text, domain) {
  return text.replace(new RegExp(`https?://${domain}(?=/)`, "g"), "");
}

const input =
  "Consider using [RegExp.escape()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/escape) to escape special characters in a string.";
const domain = "developer.mozilla.org";
console.log(removeDomain(input, domain));
// Consider using [RegExp.escape()](/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/escape) to escape special characters in a string.

Wird der obige Wert von domain eingefügt, entsteht das reguläre Ausdrucksliteral https?://developer.mozilla.org(?=/). Darin ist das Zeichen „.“ ein Regex-Platzhalterzeichen. Der Ausdruck stimmt daher auch mit Strings überein, in denen anstelle des „.“ ein beliebiges Zeichen steht, etwa developer-mozilla-org. Folglich würde er auch den folgenden Text fälschlicherweise ändern:

const input =
  "This is not an MDN link: https://developer-mozilla.org/, be careful!";
const domain = "developer.mozilla.org";
console.log(removeDomain(input, domain));
// This is not an MDN link: /, be careful!

Um dies zu beheben, können wir mit RegExp.escape() sicherstellen, dass jede Benutzereingabe als literales Muster behandelt wird:

function removeDomain(text, domain) {
  return text.replace(
    new RegExp(`https?://${RegExp.escape(domain)}(?=/)`, "g"),
    "",
  );
}

Nun verhält sich die Funktion wie beabsichtigt und verändert keine developer-mozilla.org-URLs.

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Polyfill für RegExp.escape in core-js
• Polyfill für RegExp.escape von es-shims
• RegExp