Skip to content

Format

Number, currency, duration, filesize, and percentage formatting.

5 modules

ModuleDescription
Format CurrencyFormat numbers as currency
Format DurationFormat seconds as human-readable duration
Format FilesizeFormat bytes as human-readable file size
Format NumberFormat numbers with separators and decimals
Format PercentageFormat numbers as percentages

Modules

Format Currency

format.currency

Format numbers as currency

Parameters:

NameTypeRequiredDefaultDescription
amountnumberYes-Amount to format
currencystringNoUSDAmount to format
decimal_placesnumberNo2Number of decimal places
symbol_positionstringNobeforeNumber of decimal places

Output:

FieldTypeDescription
resultstringFormatted currency string
originalnumberFormatted currency string
symbolstringFormatted currency string

Format Duration

format.duration

Format seconds as human-readable duration

Parameters:

NameTypeRequiredDefaultDescription
secondsnumberYes-Duration in seconds
formatstringNoshortDuration in seconds
show_zerobooleanNoFalseShow units that are zero

Output:

FieldTypeDescription
resultstringShow units that are zero
originalnumberFormatted duration string
partsobjectFormatted duration string

Format Filesize

format.filesize

Format bytes as human-readable file size

Parameters:

NameTypeRequiredDefaultDescription
bytesnumberYes-Size in bytes
binarybooleanNoFalseSize in bytes
decimal_placesnumberNo2Use binary units (KiB, MiB) instead of decimal (KB, MB)

Output:

FieldTypeDescription
resultstringNumber of decimal places
originalnumberFormatted file size string
unitstringFormatted file size string
valuenumberOriginal bytes

Format Number

format.number

Format numbers with separators and decimals

Parameters:

NameTypeRequiredDefaultDescription
numbernumberYes-Number to format
decimal_placesnumberNo2Number to format
thousand_separatorstringNo,Number of decimal places
decimal_separatorstringNo.Separator for thousands

Output:

FieldTypeDescription
resultstringSeparator for decimals
originalnumberFormatted number string

Format Percentage

format.percentage

Format numbers as percentages

Parameters:

NameTypeRequiredDefaultDescription
valuenumberYes-Value to format as percentage
is_ratiobooleanNoTrueValue to format as percentage
decimal_placesnumberNo1Input is a ratio (0-1) that needs to be multiplied by 100
include_signbooleanNoFalseNumber of decimal places

Output:

FieldTypeDescription
resultstringInclude + sign for positive values
originalnumberFormatted percentage string
numericnumberFormatted percentage string

Released under the Apache 2.0 License.