String.prototype.replaceAll()

pattern

Kann ein String oder ein Objekt mit einer Symbol.replace Methode sein — das typische Beispiel ist ein regulärer Ausdruck. Jeder Wert, der nicht über die Symbol.replace Methode verfügt, wird in einen String umgewandelt.

Falls pattern ein regulärer Ausdruck ist, muss dieser das globale (g) Flag gesetzt haben, oder es wird ein TypeError ausgelöst.

replacement

Kann ein String oder eine Funktion sein. Das Ersatzverhalten hat die gleichen Semantiken wie bei String.prototype.replace().

Ein neuer String, bei dem alle Vorkommen eines Musters durch eine Ersetzung ersetzt wurden.

TypeError

Wird ausgelöst, wenn das pattern ein regulärer Ausdruck ist, der nicht das globale (g) Flag gesetzt hat (dessen flags Eigenschaft enthält kein "g").

Diese Methode verändert nicht den String-Wert, auf den sie angewendet wird. Sie gibt einen neuen String zurück.

Im Gegensatz zu replace() ersetzt diese Methode alle Vorkommen eines Strings, nicht nur das erste. Obwohl es auch möglich ist, replace() mit einem dynamisch erzeugten globalen regulären Ausdruck mit RegExp() zu verwenden, um alle Instanzen eines Strings zu ersetzen, kann dies unbeabsichtigte Folgen haben, wenn der String Sonderzeichen enthält, die in regulären Ausdrücken eine Bedeutung haben (was passieren kann, wenn der Ersetzungsstring von Benutzereingaben stammt). Während Sie diesen Fall durch die Verwendung von RegExp.escape() entschärfen können, um die reguläre Ausdruckzeichenkette in ein literal pattern umzuwandeln, ist es einfacher, den String direkt an replaceAll() zu übergeben, ohne ihn in einen regulären Ausdruck umzuwandeln.

function unsafeRedactName(text, name) {
  return text.replace(new RegExp(name, "g"), "[REDACTED]");
}
function semiSafeRedactName(text, name) {
  return text.replaceAll(name, "[REDACTED]");
}
function superSafeRedactName(text, name) {
  // only match at word boundaries
  return text.replaceAll(
    new RegExp(`\\b${RegExp.escape(name)}\\b`, "g"),
    "[REDACTED]",
  );
}

let report =
  "A hacker called ha.*er used special characters in their name to breach the system.";

console.log(unsafeRedactName(report, "ha.*er")); // "A [REDACTED]s in their name to breach the system."
console.log(semiSafeRedactName(report, "ha.*er")); // "A hacker called [REDACTED] used special characters in their name to breach the system."

report = "A hacker called acke breached the system.";

console.log(semiSafeRedactName(report, "acke")); // "A h[REDACTED]r called [REDACTED] breached the system."
console.log(superSafeRedactName(report, "acke")); // "A hacker called [REDACTED] breached the system."

Wenn das pattern ein Objekt mit einer Symbol.replace Methode ist (einschließlich RegExp Objekten), wird diese Methode mit dem Zielstring und replacement als Argumente aufgerufen. Der Rückgabewert wird der Rückgabewert von replaceAll(). In diesem Fall wird das Verhalten von replaceAll() vollständig von der [Symbol.replace]() Methode kodiert und hat somit das gleiche Ergebnis wie replace() (abgesehen von der zusätzlichen Eingabevalidierung, dass der reguläre Ausdruck global ist).

Wenn das pattern ein leerer String ist, wird das Ersatzmuster zwischen jedem UTF-16-Code-Einheit eingefügt, ähnlich dem Verhalten von split().

"xxx".replaceAll("", "_"); // "_x_x_x_"

Weitere Informationen darüber, wie Regex-Eigenschaften (insbesondere das sticky Flag) mit replaceAll() interagieren, finden Sie unter RegExp.prototype[Symbol.replace]().

Bei der Verwendung eines regulären Ausdrucks als Suchwert muss dieser global sein. Das wird nicht funktionieren:

"aabbcc".replaceAll(/b/, ".");
// TypeError: replaceAll must be called with a global RegExp

Das wird funktionieren:

"aabbcc".replaceAll(/b/g, ".");
("aa..cc");

• Polyfill von String.prototype.replaceAll in core-js
• es-shims Polyfill von String.prototype.replaceAll
• Regular Expressions Leitfaden
• String.prototype.replace()
• String.prototype.match()
• RegExp.prototype.exec()
• RegExp.prototype.test()