transformation

String.prototype.padStart

Returns a new string padded on the left with padString (default ' ') until it reaches targetLength. Added in ES2017; the original is returned unchanged if it is already long enough.

str.padStart(targetLength[, padString])

Parameters

Parameter Purpose
targetLength Desired final length in UTF-16 code units
padString String used for padding (default ' '); truncated if too long

Examples

console.log('5'.padStart(3, '0'));

Prints '005'

console.log('42'.padStart(6));

Prints ' 42'

console.log('abc'.padStart(2, '0'));

Prints 'abc' (already >= targetLength)

console.log('x'.padStart(5, 'ab'));

Prints 'ababx'

Gotcha

Counts UTF-16 code units, so emoji (surrogate pairs) count as 2. If padString is empty the result is unchanged.

Related methods

← All JS string methods · JS array methods