String.prototype.substr()

試してみましょう

const str = "Mozilla";

console.log(str.substr(1, 2));
// 予想される結果: "oz"

console.log(str.substr(2));
// 予想される結果: "zilla"

構文

substr(start)
substr(start, length)

引数

start

返却する部分文字列に含まれる最初の文字の位置です。

length 省略可

取り出す文字の数です。

返値

指定された文字列の指定された部分が入った新しい文字列です。

解説

文字列の substr() メソッドは、その文字列の start のインデックスから length 文字分を数えて抽出します。

• start >= str.length である場合、空文字列が返されます。
• start < 0 である場合、文字列の末尾から数えたインデックスになります。厳密には、この場合は max(start + str.length, 0) で始まる部分文字列になります。
• start が省略されたか undefined であった場合、0 として扱われます。
• length が省略されたか undefined であった場合、またはstart + length >= str.length であった場合、substr() は文字列の末尾まで文字を抽出します。
• length < 0 の場合、空文字列が返されます。
• start と length のどちらでも、NaN は 0 として扱われます。

substr() の使用を避けることが推奨されますが、レガシーコードにおいて substr() を slice() または substring() に移行する簡単な方法はありません。例えば、str = "01234", a = 1, l = -2 の場合、str.substr(a, l), str.slice(a, a + l), str.substring(a, a + l) はすべて異なる結果を返します。 substr() は空文字列を返し、slice() は "123" を返し、substring() は "0" を返します。実際のリファクタリング方法は、a と l の範囲に関する知識に依存します。

例

substr() の使用

const aString = "Mozilla";

console.log(aString.substr(0, 1)); // 'M'
console.log(aString.substr(1, 0)); // ''
console.log(aString.substr(-1, 1)); // 'a'
console.log(aString.substr(1, -1)); // ''
console.log(aString.substr(-3)); // 'lla'
console.log(aString.substr(1)); // 'ozilla'
console.log(aString.substr(-20, 2)); // 'Mo'
console.log(aString.substr(20, 2)); // ''

仕様書

ブラウザーの互換性

関連情報

• String.prototype.substr のポリフィル (core-js)
• es-shims による String.prototype.substr のポリフィル
• String.prototype.slice()
• String.prototype.substring()