Variable formattersConst

Type Declaration

• currency: (currency?: string, decimals?: number, locale?: string) => FormatFunction

  Creates a currency formatter.

  Example

  formatters.currency('USD', 2)(1234.5) // "$1,234.50"
  formatters.currency('EUR', 0, 'de-DE')(1234) // "1.234 EUR"
  Copy

• percent: (decimals?: number) => FormatFunction

  Creates a percentage formatter.

  Example

  formatters.percent(1)(0.156) // "15.6%"
  formatters.percent(0)(0.75) // "75%"
  Copy

• date: (options?: DateTimeFormatOptions, locale?: string) => FormatFunction

  Creates a date formatter using Intl.DateTimeFormat.

  Example

  formatters.date({ month: 'short', day: 'numeric' })('2023-01-15') // "Jan 15"
  formatters.date({ year: 'numeric', month: 'long' })(1704067200000) // "January 2024"
  Copy

• number: (decimals?: number, locale?: string) => FormatFunction

  Creates a number formatter with optional decimal places and grouping.

  Example

  formatters.number(2)(1234567.89) // "1,234,567.89"
  formatters.number(0, 'de-DE')(1234567) // "1.234.567"
  Copy

• scientific: (decimals?: number) => FormatFunction

  Creates a scientific notation formatter.

  Example

  formatters.scientific(2)(1234567) // "1.23e+6"
  formatters.scientific(3)(0.000123) // "1.230e-4"
  Copy

• fixed: (decimals?: number) => FormatFunction

  Creates a fixed decimal places formatter.

  Example

  formatters.fixed(2)(3.14159) // "3.14"
  formatters.fixed(0)(3.7) // "4"
  Copy