String.prototype.substr()

Метод substr() (підрядок) значень String повертає порцію рядка, яка починається за вказаним індексом і продовжується протягом заданої кількості символів.

[!NOTE] Метод substr не є частиною специфікації ECMAScript: він означений в Додатку B: Додаткових можливостях ECMAScript для веббраузерів, котрий є нормативним необов'язковим для небраузерних платформ. Таким чином, краще користуватися замість нього стандартними методами String.prototype.substring() і String.prototype.slice(), аби код виходив якнайкраще кросплатформовим. Сторінка String.prototype.substring() містить порівняння цих трьох методів.

Спробуйте його в дії

Синтаксис

substr(start)
substr(start, length)

Параметри

start

Індекс першого символу, який буде включено до поверненого підрядка.

length Необов'язкове

Кількість символів, які будуть вибрані.

Повернене значення

Новий рядок, який містить вказану частину початкового рядка.

Опис

Метод рядка substr() видобуває з цього рядка length символів, рахуючи від індексу start.

• Якщо 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(), не додаючи по суті поліфіл substr(). Наприклад, str.substr(a, l), str.slice(a, a + l) і str.substring(a, a + l) дають три різні результати, коли str = "01234", a = 1, l = -2: 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
• String.prototype.slice()
• String.prototype.substring()