@swapped/connect-sdk / format / formatCompactNumber

Function: formatCompactNumber()

formatCompactNumber(number?, customFormat?): string

Defined in: src/format/formatCompactNumber.ts:12

Formats a number into a compact human-readable abbreviation (e.g. 1.5k, 2m). Returns an empty string when number is not a finite number value.

Parameters

number?

number

The number to format; non-numbers yield ''

customFormat?

string

Optional numeral format override (e.g. '0.00a')

Returns

string

Compact formatted string, or '' if input is invalid