NumberFormat

Methods
15
Fields
None

Methods

MethodReturnsDescription
format(number)string(NumberFormat, number) -> string: number formatted (a Luau integer takes this overload).
setMaximumFractionDigits(number)()At most newValue fraction digits.
setMinimumFractionDigits(number)()At least newValue fraction digits.
setMaximumIntegerDigits(number)()At most newValue integer digits.
setMinimumIntegerDigits(number)()At least newValue integer digits.
getMaximumFractionDigits()numberThe most fraction digits.
getMinimumFractionDigits()numberThe fewest fraction digits.
getMaximumIntegerDigits()numberThe most integer digits.
getMinimumIntegerDigits()numberThe fewest integer digits.
setGroupingUsed(boolean)()Whether digits are grouped.
isGroupingUsed()booleanWhether digits are grouped.
getInstance()DecimalFormat#,##0.### in the default locale.
getNumberInstance()DecimalFormat#,##0.### in the default locale.
getIntegerInstance()DecimalFormat#,##0 rounding HALF_EVEN, parsing integers only.
getPercentInstance()DecimalFormat#,##0%.

Method details

format

format: (NumberFormat, number) -> string

(NumberFormat, number) -> string: number formatted (a Luau integer takes this overload).

(NumberFormat, number) -> string: number formatted, rounding by the rounding mode (HALF_EVEN by default).