RegExp.escape()

string

Der zu escapende String.

Ein neuer String, der sicher als literales Muster für den RegExp() Konstruktor verwendet werden kann. Insbesondere werden folgende Dinge im Eingabewert ersetzt:

• Das erste Zeichen des Strings, falls es entweder eine Dezimalziffer (0–9) oder ein ASCII-Buchstabe (a–z, A–Z) ist, wird mit der \x character escape Syntax escaped. Zum Beispiel gibt RegExp.escape("foo") "\\x66oo" zurück (hier und nachfolgend bezeichnen die beiden Backslashes in einem String-Literal ein einzelnes Backslash-Zeichen). Dieser Schritt stellt sicher, dass, wenn dieser escapede String in ein größeres Muster eingebettet wird, wo er unmittelbar von \1, \x0, \u000 etc. gefolgt wird, das führende Zeichen nicht als Teil der Escape-Sequenz interpretiert wird.
• Regex syntax characters, einschließlich ^, $, \, ., *, +, ?, (, ), [, ], {, }, und |, sowie dem / Delimiter, werden durch Einfügen eines \ Zeichens davor escapet. Zum Beispiel gibt RegExp.escape("foo.bar") "\\x66oo\\.bar" zurück und RegExp.escape("(foo)") gibt "\\(foo\\)" zurück.
• Andere Satzzeichen, einschließlich ,, -, =, <, >, #, &, !, %, :, ;, @, ~, ', `, und ", werden mit der \x Syntax escapet. Zum Beispiel gibt RegExp.escape("foo-bar") "\\x66oo\\x2dbar" zurück. Diese Zeichen können nicht durch Voranstellen mit \ escapet werden, weil zum Beispiel /foo\-bar/u ein Syntaxfehler ist.
• Die Zeichen mit ihren eigenen character 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. Zum Beispiel gibt RegExp.escape("foo\nbar") "\\x66oo\\nbar" zurück.
• Das Leerzeichen wird als "\\x20" escapet.
• Andere nicht-ASCII line break and white space characters werden durch ein oder zwei \uXXXX Escape-Sequenzen ersetzt, die ihre UTF-16 Code-Einheiten darstellen. Zum Beispiel gibt RegExp.escape("foo\u2028bar") "\\x66oo\\u2028bar" zurück.
• Lone surrogates werden durch ihre \uXXXX Escape-Sequenzen ersetzt. Zum Beispiel gibt RegExp.escape("foo\uD800bar") "\\x66oo\\ud800bar" zurück.

TypeError

Wird ausgelöst, wenn string kein String ist.

Die folgenden Beispiele demonstrieren verschiedene Eingaben und Ausgaben für die RegExp.escape() Methode.

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"

Der Hauptanwendungsfall von RegExp.escape() ist, wenn Sie einen String in ein größeres Regex-Muster einbetten möchten und sicherstellen möchten, dass der String als literal Pattern behandelt wird und nicht als Regex-Syntax. Betrachten Sie das folgende naive 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.

Das Einfügen der domain oben führt zu dem regulären Ausdruckliteral https?://developer.mozilla.org(?=/), wobei das "." Zeichen ein Regex wildcard Zeichen ist. Das bedeutet, dass der String den String mit jedem Zeichen an Stelle des ".", wie developer-mozilla-org, übereinstimmt. Daher würde es fälschlicherweise auch den folgenden Text ä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 RegExp.escape() verwenden, um sicherzustellen, dass jede Benutzereingabe als literales Muster behandelt wird:

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

Nun wird diese Funktion genau das tun, was wir beabsichtigen, und nicht developer-mozilla.org URLs transformieren.

• Polyfill von RegExp.escape in core-js
• RegExp