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

substrメソッドは、Stringクラスのインスタンスに対して使用され、文字列から指定した開始位置と長さに基づいて部分文字列を抽出するメソッドです。このメソッドは、元の文字列を変更することなく、抽出された新しい文字列を返します。

このメソッドは主に二つの引数を取ります。最初の引数は、部分文字列の抽出を開始する位置を示す数値（インデックス）です。このインデックスは文字列の先頭を0として数えます。もし負の値を指定した場合、その値は文字列の末尾からのオフセットとして解釈されます。例えば、-1は文字列の最後の文字を意味します。二つ目の引数は、抽出する文字の長さを指定する数値です。この引数を省略した場合、または指定した長さが開始位置から文字列の末尾までの残りの文字数を超える場合は、開始位置から文字列の末尾まですべての文字が抽出されます。もし二つ目の引数に0以下の値を指定した場合、空の文字列が返されます。

ただし、substrメソッドはECMAScriptの仕様においてレガシーな機能とされており、将来のバージョンで非推奨または削除される可能性があります。そのため、新しいコードを記述する際には、このメソッドの使用は推奨されていません。代わりに、同様の機能を提供し、より現代的なJavaScriptの標準に準拠しているsubstring()メソッドやslice()メソッドの使用が推奨されます。これらの代替メソッドは、引数の指定方法が異なる場合があるものの、部分文字列の抽出においてより柔軟で予測可能な振る舞いをします。substrメソッドを利用する際は、この非推奨であることを理解し、可能であれば代替メソッドへの移行を検討することが重要です。

Copy
1const originalString = "Hello, World!";
2const substring = originalString.substr(7, 5);

start, length

• start: string: 抽出を開始する位置を示す数値。省略した場合は0になります。
• length: number: 抽出する文字数を示す数値。省略した場合は、文字列の最後まで抽出します。

string

指定された位置から指定された文字数分の文字列を切り出した新しい文字列を返します。