【JavaScript ECMAScript】RegExp::RegExp.prototype.flagsインスタンスアクセサプロパティの使い方
RegExp.prototype.flagsインスタンスアクセサプロパティの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
RegExp.prototype.flagsプロパティは、正規表現オブジェクトに設定されているフラグを文字列として保持するプロパティです。このプロパティは、正規表現がどのようなオプションで動作するかをプログラム上で確認できます。
正規表現のフラグは、検索の挙動を制御するオプションです。例えば'g'（グローバル検索）、'i'（大文字小文字無視）、'm'（複数行モード）などがあります。このプロパティは、正規表現オブジェクト作成時に指定されたフラグを結合した文字列を返します。
具体的には、/pattern/giのような正規表現オブジェクトの場合、このプロパティは"gi"という文字列を返します。フラグが設定されていない正規表現であれば、空文字列""が返されます。
このプロパティは読み取り専用であるため、一度作成された正規表現オブジェクトのフラグを後から変更することはできません。システム開発において、正規表現の挙動を検査し、特定のフラグの有無に応じて処理を分岐させる際に、その設定情報を正確に把握するために利用されます。
公式リファレンス: RegExp.prototype.flags
構文(syntax)
1const myRegex = /pattern/gim; 2const flags = myRegex.flags;
引数(parameters)
引数なし
引数はありません
戻り値(return)
String
RegExp.prototype.flags は、正規表現リテラルまたはコンストラクタで作成された正規表現オブジェクトに設定されているフラグ（g, i, m, s, u, y）を文字列で返します。