Symbol.replace

فهرست فصل‌ها دانلود آرشیوناشر

MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونه‌کد

The **Symbol.replace** static data property represents the well-known symbol Symbol.replace. The {{jsxref("String.prototype.replace()")}} and {{jsxref("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]()](/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/Symbol.replace), {{jsxref("String.prototype.replace()")}}, and {{jsxref("String.prototype.replaceAll()")}}.

{{InteractiveExample("JavaScript Demo: Symbol.replace")}}

js interactive-example
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.

{{js_property_attributes(0, 0, 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

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • [Polyfill of Symbol.replace in core-js](https://core-js.io/docs/features/ecmascript/symbol)
  • {{jsxref("Symbol.match")}}
  • {{jsxref("Symbol.matchAll")}}
  • {{jsxref("Symbol.search")}}
  • {{jsxref("Symbol.split")}}
  • {{jsxref("String.prototype.replace()")}}
  • {{jsxref("String.prototype.replaceAll()")}}
  • [RegExp.prototype[Symbol.replace]()](/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/Symbol.replace)