Symbol.replace
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.
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().
JavaScript Demo: Symbol.replace
``js interactive-example
class Replace1 {
constructor(value) {
this.value = value;
}
[Symbol.replace](string) {
returns/${string}/${this.value}/g`;
}
}
console.log("foo".replace(new Replace1("bar"))); // Expected output: "s/foo/bar/g"
## Value
The well-known symbol `Symbol.replace`.
0
## Examples
### Using Symbol.replace
<!-- cSpell:ignore tball -->
```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
Browser compatibility
See also
- Polyfill of
Symbol.replaceincore-js - Symbol.match
- Symbol.matchAll
- Symbol.search
- Symbol.split
- String.prototype.replace()
- String.prototype.replaceAll()
RegExp.prototype[Symbol.replace]()