leftPad

leftPad(String, Number, String): String

The specified text is left-padded to the size using the padText. By default padText is " ".

Returns left-padded String or original String if no padding is necessary.

Introduced in DataWeave 2.2.0. Supported by Mule 4.2 and later.

Parameters

Name Description

Name	Description
`text`	The input string.
`size`	The size to pad to.
`padText`	The text to pad with. It defaults to one space if not specified.

text

The input string.

size

The size to pad to.

padText

The text to pad with. It defaults to one space if not specified.

Example

This example shows how leftPad behaves with different inputs and sizes.

Source

%dw 2.0
import * from dw::core::Strings
output application/json
---
{
   "a": leftPad(null, 3),
   "b": leftPad("", 3),
   "c": leftPad("bat", 5),
   "d": leftPad("bat", 3),
   "e": leftPad("bat", -1)
}

Output

{
  "a": null,
  "b": "   ",
  "c": "  bat",
  "d": "bat",
  "e": "bat"
}

leftPad(Null, Number, String): Null

Helper function that enables leftPad to work with a null value.