Summary
Pads the start of a string with another string.
Description
Pads the current string with a given string (repeated, if needed) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string.
Route
No Northbound API Available
Roles
Parameters
DetailsExampleSchema
| Name | Type | Required | Description |
|---|---|---|---|
| str | string | yes | The string to pad onto |
| targetLength | number | yes | The length of the resulting string once the current string has been padded. If lower than str's length, returns str |
| padString | string | yes | The string to pad the current string with |
Return
DetailsExampleSchema
| Name | Type | Description |
|---|---|---|
| paddedString | string | A string of specified length with the pad string applied at the start of the current string |