padRight

Description

Adds characters to the end of a string until it reaches the desired length. If the string is longer than the target length, it is truncated from the end.

Syntax

Like many functions in DataPrime, padRight supports two notations, function and method notation. These interchangeable forms allow flexibility in how you structure expressions.

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

(value: string).padRight(charCount: number, fillWith: string): string

Arguments

Example

Ensure all strings are the same length

Consider the following documents:

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

Use padRight to make all names 10 characters long:

create name_padded from padRight(name, 10, 'X')

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

Output

{
    "name": "Chris",
    "name_padded": "ChrisXXXXX"
}
{
    "name": "David",
    "name_padded": "DavidXXXXX"
}
{
    "name": "John",
    "name_padded": "JohnXXXXXX"
}