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 โจJanuary 2020โฉ.
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
js
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ยฎ 2026 Language Specification # sec-symbol.replace |
Browser compatibility
Loadingโฆ