【JavaScript ECMAScript】Symbol::Symbol.replace静的データプロパティの使い方

Symbol.replaceプロパティは、Well-known Symbolの一つで、JavaScriptの文字列置換操作の振る舞いを定義するために使用されるシンボル値を保持するプロパティです。このシンボルは、String.prototype.replace()メソッドが内部的に利用する仕組みの中心にあります。String.prototype.replace()メソッドは、最初の引数に渡されたオブジェクトがどのように文字列を置換すべきかを判断するために、そのオブジェクトが[Symbol.replace]というメソッドを持っているかどうかを確認します。

たとえば、JavaScriptに組み込まれている正規表現オブジェクト（RegExpインスタンス）は、デフォルトで[Symbol.replace]メソッドを実装しています。そのため、"文字列".replace(/正規表現/, "置換文字")のように正規表現を使って文字列を置換すると、期待通りに動作します。これはRegExpオブジェクトがSymbol.replaceで定義されたロジックに従って置換処理を実行するためです。

開発者は、独自のオブジェクトを作成する際に、そのオブジェクトに[Symbol.replace](targetString, replaceValue)という名前のメソッドを定義することで、String.prototype.replace()の動作をカスタマイズできます。これにより、正規表現のパターンマッチングに縛られず、特定の条件やロジックに基づいて文字列を置換する柔軟な処理を実装することが可能になります。Symbol.replaceは、JavaScriptにおける文字列操作の拡張性を高めるための重要な機能を提供するプロパティです。

Copy
1const customReplacer = {
2  [Symbol.replace](targetString, replacement) {
3    // targetString は replace() メソッドが呼び出された元の文字列
4    // replacement は replace() メソッドの第2引数
5    // 例: targetString 内の 'a' を replacement に置換するカスタムロジック
6    return targetString.replace(/a/g, replacement);
7  }
8};
9
10"banana".replace(customReplacer, "X");

引数なし

引数はありません

symbol

Symbol.replaceは、文字列のreplaceメソッドが内部的に呼び出すための、組み込みシンボルです。このシンボル自体は、特別な用途のために定義された一意の値であり、直接的な計算結果やデータ構造を返すものではありません。