Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

Symbol.search静的データプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

Symbol.searchプロパティは、JavaScriptの標準的な文字列検索メソッドであるString.prototype.search()の動作をカスタマイズするために使用される、組み込みのSymbol値を保持するプロパティです。

このプロパティが保持するSymbol値は、「ウェルノウンシンボル」と呼ばれる特別な定数の一つであり、特定の内部的な処理の挙動を開発者が定義した独自のロジックに置き換える目的で利用されます。具体的には、"検索対象文字列".search(mySearchObject)のように、String.prototype.search()メソッドに正規表現オブジェクトではない任意のオブジェクトmySearchObjectを引数として渡した場合に、JavaScriptエンジンはまずmySearchObjectSymbol.searchプロパティにメソッドを持っているかどうかを内部的に確認します。

もしmySearchObject[Symbol.search]にメソッドが定義されていれば、String.prototype.search()は正規表現による通常の検索処理ではなく、このmySearchObject[Symbol.search]メソッドを呼び出します。このメソッドは、検索対象の文字列(上記の例では"検索対象文字列")と、引数として渡されたオブジェクト自身(mySearchObject)を引数として受け取ります。そして、独自の検索ロジックを実行し、文字列内で一致が見つかった最初のインデックスを数値で返すか、見つからなかった場合は-1を返すべきです。

このように、Symbol.searchを利用することで、開発者は正規表現以外のオブジェクトに対しても、String.prototype.search()と互換性のある独自の検索ロジックを実装し、標準メソッドの動作を柔軟に拡張することが可能になります。これにより、アプリケーションの特定のニーズに合わせて、多様なデータ型を検索パターンとして扱えるようになります。

公式リファレンス: Symbol.search

構文(syntax)

1class CustomSearchObject {
2  [Symbol.search](string) {
3    return string.indexOf('찾고자하는문자열');
4  }
5}

引数(parameters)

引数なし

引数はありません

戻り値(return)

symbol

Symbol.searchは、文字列のsearch()メソッドによって内部的に使用されるシンボルを返します。これは、特定の文字列検索アルゴリズムをカスタマイズするために使用できます。

関連コンテンツ

関連プログラミング言語