The Symbol.replace well-known symbol specifies the method that replaces matched substrings of a string. This function is called by the String.prototype.replace() method.

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

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


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')));
// expected output: "#!@?tball"


ECMAScript (ECMA-262)
The definition of 'Symbol.replace' in that specification.

Browser compatibility

Update compatibility data on GitHub
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung InternetNode.js
replaceChrome Full support 50Edge Full support 79Firefox Full support 49IE No support NoOpera Full support 37Safari Full support 10WebView Android Full support 50Chrome Android Full support 50Firefox Android Full support 49Opera Android Full support 37Safari iOS Full support 10Samsung Internet Android Full support 5.0nodejs Full support 6.0.0


Full support  
Full support
No support  
No support

See also