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

【Node.js24.x】String::substring()メソッドの使い方

substringメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

substringメソッドは、Stringオブジェクトが保持する文字列から、指定された範囲の部分文字列を抽出し、新しい文字列として返却するメソッドです。このメソッドは、抽出を開始する位置を示すindexStartと、抽出を終了する位置の直後を示すindexEnd(オプション)の二つの引数を受け取ります。indexStartは文字列の先頭から数えて0から始まるインデックスで、抽出はこの位置の文字から開始されます。

indexEndが指定された場合、抽出はindexEndで指定された位置の直前までとなり、その位置の文字は含まれません。例えば、indexEndが3であれば、インデックス0, 1, 2の文字が抽出されます。indexEndが省略された場合、または指定された値が文字列の長さと等しいかそれ以上の場合、文字列の最後までが抽出範囲となります。

引数として渡されるindexStartindexEndに負の数やNaN(Not-a-Number)が指定された場合、これらは自動的に0として扱われます。また、もしindexStartの値がindexEndよりも大きい場合でも、メソッドは自動的に二つの引数を入れ替えて処理を行うため、常に正しい範囲で部分文字列が抽出されます。このメソッドによって返されるのは元の文字列とは独立した新しい文字列であり、元のStringオブジェクトの文字列が変更されることはありません。文字列の一部を安全に取り出して利用したい場合に非常に役立つ機能です。

構文(syntax)

1const originalString = "Hello JavaScript!";
2const extractedSubstring = originalString.substring(0, 5);

引数(parameters)

indexStart, indexEnd = undefined

  • indexStart: string の切り出しを開始する位置を指定する数値
  • indexEnd: string の切り出しを終了する位置を指定する数値。省略された場合は、string の末尾までが切り出されます。

戻り値(return)

string

指定された位置から文字列の末尾までの部分文字列を返します。

関連コンテンツ

関連プログラミング言語