formatNumber

Formats a number to a string with support for decimal places, unit conversion, thousand separators, and more.

Syntax

formatNumber(value: number | string, options?: FormatNumberOptions): string

Arguments

value

The number to format.

• Type: number | string

options

The options object.

• Type: FormatNumberOptions
• Optional

FormatNumberOptions

Property	Type	Default	Description
prec	boolean | number	false	Decimal precision: true rounds to 1 place, false skips rounding, number rounds to specified places.
unit	"%" | "k" | "M" | "none"	"none"	Unit for formatting
separator	boolean	true	Whether to add thousand separators
showUnit	boolean	false	Whether to display unit text

Returns

• Type: string

Returns the formatted string.

Example

formatNumber(1234567.89)
// => "1,234,567.89"

formatNumber(1234567.89, { prec: true })
// => "1,234,567.9"

formatNumber(1234567.89, { prec: 2 })
// => "1,234,567.89"

formatNumber(0.75, { unit: "%", showUnit: true })
// => "75%"

formatNumber(1234567, { unit: "k", showUnit: true })
// => "1,234.567k"

formatNumber(1234567, { unit: "M", showUnit: true })
// => "1.234567M"