Carrot reference
Functions

formatPercent()

Converts a given value of type Percent into a String.

Syntax

formatPercent(percent[, format][, locale])

  • percent - the Percent value to be converted to a String
  • places - the number of places of the returned value
  • locale -
  • Return type: String

Sample usage

formatPercent(.5) returns 50% as a String.

Supported data types

Input type

Return type

Logic

Percent

String

If a Percent value is passed, it's value will returned as a String.

Unsupported data types

Null

Unsupported data types return Null.



Updated 04 Oct 2023
Doc contributor
Did this page help you?