【JavaScript ECMAScript】String::String.prototype.searchインスタンスメソッドの使い方
String.prototype.search()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
String.prototype.search()メソッドは、呼び出し元のStringオブジェクトに対して、引数で指定された正規表現に最初に一致する部分文字列の開始インデックスを検索し、その位置を数値で返すメソッドです。このメソッドは、引数として正規表現オブジェクト、または正規表現として解釈される文字列を受け取ります。
検索が成功し、文字列内に指定されたパターンに一致する部分が見つかった場合、その一致の開始位置を示す0から始まるインデックスが返されます。例えば、文字列の先頭に一致が見つかった場合は0が、文字列の先頭から2番目の文字に一致が見つかった場合は1が返されます。もし、対象の文字列内に一致する部分が全く見つからなかった場合は、-1が返されます。
このメソッドは、文字列の中に特定の単語やパターンが存在するかどうかを確認し、その出現位置を知りたい場合に特に有用です。正規表現を用いることで、単純な文字列の検索だけでなく、より複雑な条件に基づいたパターンマッチングを行うことが可能になります。システム開発において、ユーザーからの入力検証や、ログ解析時の特定情報の抽出など、文字列を効率的に処理する様々な場面で活用される基本的な機能の一つです。
公式リファレンス: String.prototype.search()
構文(syntax)
1const stringObject = "JavaScript is fun!"; 2const firstMatchIndex = stringObject.search(/script/); 3// firstMatchIndex は 4 になります
引数(parameters)
regexp
- regexp: RegExp: 検索する正規表現オブジェクト
戻り値(return)
Number
文字列内に正規表現に一致する最初の部分文字列のインデックスを返します。一致が見つからない場合は、-1 を返します。