このページはコミュニティーの尽力で英語から翻訳されました。MDN Web Docs コミュニティーについてもっと知り、仲間になるにはこちらから。

View in English Always switch to English

Symbol.replace

Baseline 広く利用可能

この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2020年1月以降、すべてのブラウザーで利用可能です。

Symbol.replace は静的データプロパティで、ウェルノウンシンボルSymbol.replace を表します。String.prototype.replace() および String.prototype.replaceAll() メソッドは第 1 引数で、現在のオブジェクトに一致する部分文字列を置き換えるメソッドを、このシンボルで探します。

詳しくは、RegExp.prototype[Symbol.replace]()String.prototype.replace()String.prototype.replaceAll() を参照してください。

試してみましょう

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

console.log("foo".replace(new Replace1("bar")));
// 予想される結果: "s/foo/bar/g"

ウェルノウンシンボル Symbol.replace です。

Symbol.replace のプロパティ属性
書込可能不可
列挙可能不可
設定可能不可

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"

仕様書

仕様書
ECMAScript® 2027 Language Specification
# sec-symbol.replace

ブラウザーの互換性

関連情報