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

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

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

作成日: 更新日:

基本的な使い方

Symbol.matchプロパティは、JavaScriptにおいて、特定のオブジェクトが正規表現のように振る舞い、文字列を照合(マッチング)する際の挙動を定義するために使われる、特殊なシンボル値を持つプロパティです。

このプロパティはSymbolオブジェクトの静的データプロパティであり、主にString.prototype.match()メソッドの動作をカスタマイズする目的で利用されます。例えば、String.prototype.match()メソッドに引数としてオブジェクトが渡された際、JavaScriptエンジンはそのオブジェクトがSymbol.matchという名前のプロパティを持っているかを確認します。もしこのプロパティが存在し、かつ関数(メソッド)が設定されていれば、String.prototype.match()はその関数を呼び出し、文字列のマッチング処理を実行させます。

これにより、開発者は正規表現オブジェクト(RegExp)だけでなく、独自のルールに基づいた文字列照合ロジックを持つオブジェクトを作成し、それをString.prototype.match()メソッドで利用できるようになります。例えば、日付形式や特定のパターンに一致するかを判定するカスタムオブジェクトを、標準のmatchメソッドを通じて簡単に扱えるようになります。これは、JavaScriptの組み込みメソッドの振る舞いを柔軟に拡張するための強力なメカニズムです。

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

構文(syntax)

1const customMatcher = {
2  [Symbol.match](str) {
3    if (str.includes('example')) {
4      return ['example'];
5    }
6    return null;
7  }
8};
9
10const targetString = "This is an example string.";
11const matchResult = targetString.match(customMatcher);

引数(parameters)

引数なし

引数はありません

戻り値(return)

Symbol

Symbol.match は、正規表現マッチング操作で、String.prototype.match() メソッドによって使用されるシンボルです。このプロパティは、常に Symbol 型の値を返します。

関連コンテンツ

関連プログラミング言語