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

search定数は、JavaScriptおよびNode.jsにおいて、文字列の検索操作の振る舞いをカスタマイズするために使用される、組み込みのSymbolオブジェクトが提供する特別な定数を表す定数です。この定数は「well-known Symbol（よく知られたシンボル）」の一つであり、主にString.prototype.search()メソッドの内部的な動作を定義するために利用されます。

String.prototype.search(searchValue)メソッドが呼び出された際、引数として渡されたsearchValueオブジェクトがSymbol.searchという名前のメソッドを持っているかどうかを確認します。もしsearchValueオブジェクトにSymbol.searchメソッドが実装されていれば、String.prototype.search()は、そのsearchValueオブジェクトのSymbol.searchメソッドを呼び出し、実際の文字列検索処理を実行します。

この仕組みにより、開発者は独自のオブジェクトにSymbol.searchメソッドを実装することで、そのオブジェクトがString.prototype.search()によってどのように処理されるかを詳細に制御できます。例えば、標準の正規表現オブジェクトとは異なる独自の検索ロジックを持つオブジェクトを作成し、それをString.prototype.search()に渡すことで、特定の条件に基づいた高度な文字列検索処理を実現することが可能になります。Symbol.searchは、JavaScriptの柔軟性を高め、オブジェクトが文字列検索メソッドとどのように連携するかを定義するための、標準的かつ強力なメカニズムを提供します。

Copy
1const customSearcher = {
2  [Symbol.search](targetString) {
3    // targetString 内で 'Node.js' の最初の出現位置を検索
4    return targetString.indexOf('Node.js');
5  }
6};
7
8const text = 'Learn Node.js programming.';
9const index = text.search(customSearcher);

引数なし

引数はありません

symbol

Symbol.search は、オブジェクトが RegExp.prototype.search() メソッドによって検索される際に、内部的に呼び出されるメソッドを指定するために使用される組み込みシンボルです。このシンボルをプロパティとして持つオブジェクトは、文字列内の検索パターンとの一致を検出するためのアルゴリズムを定義できます。