Connect SDK

Appearance

@swapped/connect-sdk / format / FormatCurrencyParams

Type Alias: FormatCurrencyParams ​

FormatCurrencyParams = object

Defined in: src/format/formatCurrency.ts:5

Properties ​

decimals? ​

optional decimals?: number

Defined in: src/format/formatCurrency.ts:9

Decimal places to keep. Defaults to 2. 0 means no fractional part.

format? ​

optional format?: "js-number" | "pretty"

Defined in: src/format/formatCurrency.ts:15

Output style:

  • 'pretty' (default) — thousand separators (1,234.56)
  • 'js-number' — no separators, safer to parse/reuse (1234.56)

number ​

number: number | string

Defined in: src/format/formatCurrency.ts:7

Value to format (number or numeric string). Scientific notation is expanded.