Skip to main content

Function: format()

Call Signature​

format(value, options?): string

Defined in: number/format/index.ts:31

Formats a number with specified decimal places and grouping.

Uses the Intl.NumberFormat API for locale-aware formatting.

Parameters​

value​

number

The number to format

options?​

FormatOptions

Formatting options

Returns​

string

The formatted number string

Example​

// Data-first
format(1234.5678) // => "1,234.57"
format(1234.5678, { decimals: 0 }) // => "1,235"
format(1234.5678, { useGrouping: false }) // => "1234.57"
format(1234.5678, { locale: 'de-DE' }) // => "1.234,57"

// Data-last (in pipe)
pipe(
  price,
  format({ decimals: 2 })
) // => formatted price

See​

  • toCurrency - for currency-specific formatting
  • toPercent - for percentage formatting

Call Signature​

format(options?): (value) => string

Defined in: number/format/index.ts:32

Formats a number with specified decimal places and grouping.

Uses the Intl.NumberFormat API for locale-aware formatting.

Parameters​

options?​

FormatOptions

Formatting options

Returns​

The formatted number string

(value): string

Parameters​

value​

number

Returns​

string

Example​

// Data-first
format(1234.5678) // => "1,234.57"
format(1234.5678, { decimals: 0 }) // => "1,235"
format(1234.5678, { useGrouping: false }) // => "1234.57"
format(1234.5678, { locale: 'de-DE' }) // => "1.234,57"

// Data-last (in pipe)
pipe(
  price,
  format({ decimals: 2 })
) // => formatted price

See​

  • toCurrency - for currency-specific formatting
  • toPercent - for percentage formatting