pad - Pad start of a string with a given character

Alias for padLeft

pad will add additional values to the beginning of a string up to a desired length.

NOTE: If the size of the string is greater than the desired character count, the string will be truncated from the end. For example, Chris with charCount of 3 becomes Chr.

Syntax

pad(value: string, charCount: number, fillWith: string): string

Arguments

Name	Type	Required	Description
value	string	true	The string to pad
charCount	number	true	The desired character count. If less than value, string will be truncated
fillWith	string	true	The padding character

NOTE: fillWith MUST be a single character string.

Example - Ensuring all strings are the same length

Consider the following documents:

{
    "name": "Chris"
},
{
    "name": "David"
},
{
    "name": "John"
}

We may wish to make sure all of these strings are padded to the same length. We can do this using pad:

create name_padded from name.pad(10, 'X')

This will result in the following document:

{
    "name": "Chris",
    "name_padded": "XXXXXChris"
},
{
    "name": "David",
    "name_padded": "XXXXXDavid"
},
{
    "name": "John",
    "name_padded": "XXXXXXJohn"
}

matches

Next padLeft