【Node.js24.x】Symbol::replace定数の使い方

replace定数は、JavaScriptおよびNode.jsにおいて、文字列の置換動作をカスタマイズするために使用される特殊なシンボルを表す定数です。これは「Well-Known Symbol（よく知られたシンボル）」の一つであり、特定の組み込み操作の内部的な挙動をフック（介入）するために利用されます。

特に、String.prototype.replace()メソッドが呼び出される際に、その第1引数としてオブジェクトが渡された場合にこのシンボルが重要な役割を果たします。通常、String.prototype.replace()の第1引数には文字列または正規表現オブジェクトを指定しますが、カスタムオブジェクトを指定することも可能です。このカスタムオブジェクトがSymbol.replaceをキーとして持つメソッドを実装している場合、String.prototype.replace()はそのオブジェクトのSymbol.replaceメソッドを呼び出して、実際の置換処理を実行します。

Symbol.replaceメソッドは、呼び出された文字列自身と、置換文字列を引数として受け取ります。これにより、開発者は正規表現では表現が難しい、より複雑なカスタムロジックを用いた文字列の検索と置換処理を柔軟に定義できます。例えば、特定の条件に基づいて部分文字列を複数回置換したり、外部データと連携して置換内容を決定したりするような高度な処理を、String.prototype.replace()のインターフェースを通じて実現することが可能になります。この機能は、既存の組み込みメソッドの振る舞いを拡張し、多様なニーズに応えるために役立ちます。

Copy
1class CustomReplacer {
2  [Symbol.replace](targetString, replacer) {
3    return targetString.split('a').join(replacer);
4  }
5}
6
7const myCustomReplacer = new CustomReplacer();
8const originalString = "banana";
9const replacedString = originalString.replace(myCustomReplacer, "X");

引数なし

引数はありません

symbol

Symbol.replace は、文字列の replace メソッドが内部的に呼び出す際に使用されるシンボルです。このシンボル自体は、特定の値を返すのではなく、String.prototype.replace メソッドの動作をカスタマイズするための識別子として機能します。