Symbol.replace

Baseline Widely available

This feature is well established and works across many devices and browser versions. It's been available across browsers since September 2015.

The Symbol.replace static data property represents the well-known symbol Symbol.replace. The String.prototype.replace() and String.prototype.replaceAll() methods look up this symbol on their first argument for the method that replaces substrings matched by the current object.

For more information, see RegExp.prototype[Symbol.replace](), String.prototype.replace(), and String.prototype.replaceAll().

Try it

class Replace1 {
  constructor(value) {
    this.value = value;
  }
  [Symbol.replace](string) {
    return `s/${string}/${this.value}/g`;
  }
}

console.log("foo".replace(new Replace1("bar")));
// Expected output: "s/foo/bar/g"

Value

The well-known symbol Symbol.replace.

Property attributes of `Symbol.replace`
Writable	no
Enumerable	no
Configurable	no

Examples

Using Symbol.replace

class CustomReplacer {
  constructor(value) {
    this.value = value;
  }
  [Symbol.replace](string) {
    return string.replace(this.value, "#!@?");
  }
}

console.log("football".replace(new CustomReplacer("foo"))); // "#!@?tball"

Specifications

Specification
ECMAScript® 2027 Language Specification # sec-symbol.replace

Browser compatibility

	Desktop					Mobile							Server
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS	Bun	Deno	Node.js
`replace`	50	79	49	37	10	50	49	37	10	5.0	50	10	1.0.0	1.0	6.0.0