String.prototype.replace()

pattern

Kann eine Zeichenkette oder ein Objekt mit einer Symbol.replace-Methode sein — das typische Beispiel ist ein regulärer Ausdruck. Jeder Wert, der die Symbol.replace-Methode nicht hat, wird in eine Zeichenkette umgewandelt.

replacement

Kann eine Zeichenkette oder eine Funktion sein.

• Wenn es eine Zeichenkette ist, wird es die Teilzeichenkette ersetzen, die durch pattern übereinstimmt. Eine Reihe spezieller Ersetzungsmuster wird unterstützt; siehe den Abschnitt Eine Zeichenkette als Ersetzung angeben unten.
• Wenn es eine Funktion ist, wird sie für jede Übereinstimmung aufgerufen und ihr Rückgabewert wird als Ersetzungstext verwendet. Die der Funktion bereitgestellten Argumente sind im Abschnitt Eine Funktion als Ersetzung angeben unten beschrieben.

Eine neue Zeichenkette, bei der ein, einige oder alle Übereinstimmungen des Musters durch die angegebene Ersetzung ersetzt wurden.

Diese Methode verändert den Zeichenkettenwert, auf dem sie aufgerufen wird, nicht. Sie gibt eine neue Zeichenkette zurück.

Ein Zeichenfolgenmuster wird nur einmal ersetzt. Um eine globale Suche und Ersetzung durchzuführen, verwenden Sie einen regulären Ausdruck mit dem g-Flag oder verwenden Sie stattdessen replaceAll().

Wenn pattern ein Objekt mit einer Symbol.replace-Methode ist (einschließlich RegExp-Objekte), wird diese Methode mit der Zielzeichenkette und replacement als Argumenten aufgerufen. Ihr Rückgabewert wird zum Rückgabewert von replace(). In diesem Fall ist das Verhalten von replace() vollständig durch die [Symbol.replace]()-Methode kodiert — beispielsweise ist jede Erwähnung von "Erfassungsgruppen" in der unten stehenden Beschreibung eigentlich Funktionalität, die von RegExp.prototype[Symbol.replace]() bereitgestellt wird.

Wenn das pattern eine leere Zeichenkette ist, wird die Ersetzung am Anfang der Zeichenkette eingefügt.

"xxx".replace("", "_"); // "_xxx"

Ein regulärer Ausdruck mit dem g-Flag ist der einzige Fall, in dem replace() mehr als einmal ersetzt. Weitere Informationen darüber, wie Regex-Eigenschaften (insbesondere das sticky-Flag) mit replace() interagieren, finden Sie unter RegExp.prototype[Symbol.replace]().

Die Ersetzungszeichenkette kann die folgenden speziellen Ersetzungsmuster enthalten:

$n und $<Name> sind nur verfügbar, wenn das pattern-Argument ein RegExp-Objekt ist. Wenn das pattern eine Zeichenkette ist oder wenn die entsprechende Erfassungsgruppe nicht im Regex vorhanden ist, wird das Muster als Literalmuster ersetzt. Wenn die Gruppe vorhanden, aber nicht übereinstimmend ist (weil sie Teil einer Disjunktion ist), wird sie durch eine leere Zeichenkette ersetzt.

"foo".replace(/(f)/, "$2");
// "$2oo"; the regex doesn't have the second group

"foo".replace("f", "$1");
// "$1oo"; the pattern is a string, so it doesn't have any groups

"foo".replace(/(f)|(g)/, "$2");
// "oo"; the second group exists but isn't matched

Sie können eine Funktion als zweiten Parameter angeben. In diesem Fall wird die Funktion nach der Übereinstimmung aufgerufen. Das Ergebnis der Funktion (Rückgabewert) wird als Ersetzungszeichenfolge verwendet.

Die Signatur der Funktion ist wie folgt:

function replacer(match, p1, p2, /* …, */ pN, offset, string, groups) {
  return replacement;
}

Die Argumente der Funktion sind wie folgt:

match

Die übereinstimmende Teilzeichenkette. (Entspricht $& oben.)

p1, p2, …, pN

Die nte Zeichenkette, die durch eine Erfassungsgruppe (einschließlich benannter Erfassungsgruppen) gefunden wurde, vorausgesetzt, das erste Argument von replace() ist ein RegExp-Objekt. (Entspricht $1, $2, usw. oben.) Zum Beispiel, wenn das pattern /(\a+)(\b+)/ ist, dann ist p1 die Übereinstimmung für \a+ und p2 die Übereinstimmung für \b+. Wenn die Gruppe Teil einer Disjunktion ist (z.B. "abc".replace(/(a)|(b)/, replacer)), wird die nicht übereinstimmende Alternative undefined sein.

offset

Der Offset der übereinstimmenden Teilzeichenkette innerhalb der gesamten betrachteten Zeichenkette. Zum Beispiel, wenn die gesamte Zeichenkette 'abcd' ist und die übereinstimmende Teilzeichenkette 'bc' ist, dann wird dieses Argument 1 sein.

string

Die gesamte betrachtete Zeichenkette.

groups

Ein Objekt, dessen Schlüssel die verwendeten Gruppennamen sind und dessen Werte die übereinstimmenden Teile (undefined, wenn nicht übereinstimmend) sind. Nur vorhanden, wenn das pattern mindestens eine benannte Erfassungsgruppe enthält.

Die genaue Anzahl der Argumente hängt davon ab, ob das erste Argument ein RegExp-Objekt ist — und, falls ja, wie viele Erfassungsgruppen es hat.

Das folgende Beispiel setzt newString auf 'abc - 12345 - #$*%':

function replacer(match, p1, p2, p3, offset, string) {
  // p1 is non-digits, p2 digits, and p3 non-alphanumerics
  return [p1, p2, p3].join(" - ");
}
const newString = "abc12345#$*%".replace(/([^\d]*)(\d*)([^\w]*)/, replacer);
console.log(newString); // abc - 12345 - #$*%

Die Funktion wird mehrfach aufgerufen, um jedes vollständige Vorkommen zu ersetzen, wenn der reguläre Ausdruck im ersten Parameter global ist.

Im folgenden Beispiel wird der reguläre Ausdruck in replace() definiert und enthält das Flag für Groß-/Kleinschreibung ignorieren.

const str = "Twas the night before Xmas...";
const newstr = str.replace(/xmas/i, "Christmas");
console.log(newstr); // Twas the night before Christmas...

Dies protokolliert 'Twas the night before Christmas...'.

Eine globale Ersetzung kann nur mit einem regulären Ausdruck durchgeführt werden. Im folgenden Beispiel enthält der reguläre Ausdruck die globale und ignore case Flags, die es replace() erlauben, jedes Vorkommen von 'apples' in der Zeichenkette durch 'oranges' zu ersetzen.

const re = /apples/gi;
const str = "Apples are round, and apples are juicy.";
const newstr = str.replace(re, "oranges");
console.log(newstr); // oranges are round, and oranges are juicy.

Dies protokolliert 'oranges are round, and oranges are juicy'.

Das folgende Skript vertauscht die Wörter in der Zeichenkette. Für den Ersetzungstext verwendet das Skript Erfassungsgruppen und die Ersetzungsmuster $1 und $2.

const re = /(\w+)\s(\w+)/;
const str = "Maria Cruz";
const newstr = str.replace(re, "$2, $1");
console.log(newstr); // Cruz, Maria

Dies protokolliert 'Cruz, Maria'.

In diesem Beispiel werden alle Vorkommen von Großbuchstaben in der Zeichenkette in Kleinbuchstaben umgewandelt, und ein Bindestrich wird unmittelbar vor der Übereinstimmungsstelle eingefügt. Wichtig ist, dass zusätzliche Operationen an dem übereinstimmenden Element erforderlich sind, bevor es als Ersetzung zurückgegeben wird.

Die Ersetzungsfunktion akzeptiert das übereinstimmende Segment als Parameter und verwendet es, um die Groß-/Kleinschreibung zu transformieren und den Bindestrich vor der Rückgabe zu verketten.

function styleHyphenFormat(propertyName) {
  function upperToHyphenLower(match, offset, string) {
    return (offset > 0 ? "-" : "") + match.toLowerCase();
  }
  return propertyName.replace(/[A-Z]/g, upperToHyphenLower);
}

Bei styleHyphenFormat('borderTop') wird 'border-top' zurückgegeben.

Da wir das Ergebnis der Übereinstimmung weiter transformieren möchten, bevor die endgültige Ersetzung vorgenommen wird, müssen wir eine Funktion verwenden. Dies erzwingt die Auswertung der Übereinstimmung vor der Methode toLowerCase(). Wenn wir versucht hätten, dies ohne Funktion zu tun, hätte toLowerCase() keine Wirkung gehabt.

// Won't work
const newString = propertyName.replace(/[A-Z]/g, "-" + "$&".toLowerCase());

Dies liegt daran, dass '$&'.toLowerCase() zunächst als stringify-Literal ausgewertet würde (was dasselbe '$&' ergibt), bevor die Zeichen als Muster verwendet würden.

Das folgende Beispiel ersetzt einen Fahrenheit-Wert durch seinen äquivalenten Celsius-Wert. Der Fahrenheit-Wert sollte eine Zahl sein, die mit "F" endet. Die Funktion gibt die Celsius-Zahl zurück, die mit "C" endet. Zum Beispiel, wenn die Eingabezahl "212F" ist, gibt die Funktion "100C" zurück. Wenn die Zahl "0F" ist, gibt die Funktion "-17.77777777777778C" zurück.

Der reguläre Ausdruck test prüft jede Zahl, die mit F endet. Die Anzahl der Fahrenheit-Grade ist für die Funktion über ihren zweiten Parameter, p1, zugänglich. Die Funktion setzt die Celsius-Zahl basierend auf der Anzahl der Fahrenheit-Grade, die als Zeichenkette an die f2c()-Funktion übergeben werden. f2c() gibt dann die Celsius-Zahl zurück. Diese Funktion ähnelt Perls s///e-Flag.

function f2c(x) {
  function convert(str, p1, offset, s) {
    return `${((p1 - 32) * 5) / 9}C`;
  }
  const s = String(x);
  const test = /(-?\d+(?:\.\d*)?)F\b/g;
  return s.replace(test, convert);
}

Angenommen, wir möchten einen Ersetzer erstellen, der die Offset-Daten an jede übereinstimmende Zeichenkette anhängt. Da die Ersetzerfunktion bereits den offset-Parameter empfängt, wäre dies trivial, wenn der Regex statisch bekannt ist.

"abcd".replace(/(bc)/, (match, p1, offset) => `${match} (${offset}) `);
// "abc (1) d"

Dieser Ersetzer wäre jedoch schwer zu verallgemeinern, wenn wir möchten, dass er mit jedem Regex-Muster funktioniert. Der Ersetzer ist variadisch — die Anzahl der Argumente, die er erhält, hängt von der Anzahl der vorhandenen Erfassungsgruppen ab. Wir können Restparameter verwenden, aber es würde auch offset, string, usw. in das Array sammeln. Dass groups je nach Identität des Regexes möglicherweise oder möglicherweise nicht übergeben wird, würde es auch erschweren, allgemein zu wissen, welches Argument dem offset entspricht.

function addOffset(match, ...args) {
  const offset = args.at(-2);
  return `${match} (${offset}) `;
}

console.log("abcd".replace(/(bc)/, addOffset)); // "abc (1) d"
console.log("abcd".replace(/(?<group>bc)/, addOffset)); // "abc (abcd) d"

Das oben stehende addOffset-Beispiel funktioniert nicht, wenn der Regex eine benannte Gruppe enthält, da in diesem Fall args.at(-2) die string anstelle des offset wäre.

Stattdessen müssen Sie die letzten paar Argumente basierend auf dem Typ extrahieren, denn groups ist ein Objekt, während string eine Zeichenkette ist.

function addOffset(match, ...args) {
  const hasNamedGroups = typeof args.at(-1) === "object";
  const offset = hasNamedGroups ? args.at(-3) : args.at(-2);
  return `${match} (${offset}) `;
}

console.log("abcd".replace(/(bc)/, addOffset)); // "abc (1) d"
console.log("abcd".replace(/(?<group>bc)/, addOffset)); // "abc (1) d"

• Polyfill von String.prototype.replace in core-js mit Korrekturen und Implementierung moderner Verhaltensweisen wie Symbol.replace Unterstützung
• String.prototype.replaceAll()
• String.prototype.match()
• RegExp.prototype.exec()
• RegExp.prototype.test()
• Symbol.replace
• RegExp.prototype[Symbol.replace]()