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

【JavaScript ECMAScript】RegExp::RegExp.prototype[Symbol.split]インスタンスメソッドの使い方

RegExp.prototype[Symbol.split]()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

RegExp.prototypeSymbol.splitメソッドは、文字列を指定した正規表現に基づいて分割し、その結果を文字列の配列として返す内部的なメソッドです。このメソッドは、JavaScriptにおいて、主にString.prototype.split()メソッドが正規表現オブジェクトを引数として受け取った際に、内部でその分割処理を実行するために呼び出される特殊なシンボルメソッドです。

具体的には、"your string".split(/pattern/)のようにString.prototype.split()メソッドに正規表現オブジェクトを渡した場合、JavaScriptエンジンは文字列オブジェクト自体ではなく、正規表現オブジェクトの[Symbol.split]メソッドを呼び出し、分割対象の文字列とオプションのlimit引数を渡します。これにより、正規表現オブジェクトが自身の定義に基づいて文字列をどのように分割するかを制御できる仕組みになっています。

返される値は、指定された正規表現によって分割された部分文字列を要素として持つ新しい配列です。例えば、/ /"hello world"を分割すると["hello", "world"]が返されます。

システムエンジニアを目指す初心者の方にとっては、このRegExp.prototype[Symbol.split]()メソッドを直接呼び出す機会はほとんどありません。日常的な文字列分割の操作では、String.prototype.split()メソッドを使用することが一般的であり、その際に正規表現を引数として渡せば、この内部的なメカニズムが自動的に利用されます。このメソッドは、JavaScriptのより深い部分、具体的にはオブジェクトがどのように特定の操作(この場合は文字列の分割)に参加するかを定義する「well-known symbols」の一つとして理解すると良いでしょう。

公式リファレンス: RegExp.prototype[Symbol.split]()

構文(syntax)

1const textToSplit = "apple-banana-cherry-date";
2const result = /-/[Symbol.split](textToSplit, 3);
3console.log(result);

引数(parameters)

str, limit

  • str: string: 分割する対象の文字列
  • limit: number: (省略可能) 生成される配列の最大長を指定する非負の整数

戻り値(return)

Array<string>

指定された正規表現に基づいて文字列を分割した結果を、文字列の配列として返します。

関連コンテンツ

関連プログラミング言語