padStart

Modified on Mon, 31 Jul 2023

Description

Pad string on the left side if it's shorter than length. Padding characters are truncated if they exceed length

Syntax

padStart(text, length, chars)

Parameters

Input ParameterTypeDescription
textstringThe string to pad.
lengthnumberThe padding length.
charsstringThe string used as padding.

Return value

Type
string

Sample

ExampleResultDescription
pad('Sam', 6, ' ')' Sam'Prepend three spaces
pad('Sam', 6, '-+')'-+-Sam'Prepend given characters to the input text.

To view all the String functions, click here.

See Also