@swapped/connect-sdk / format / formatTokenAmount

Function: formatTokenAmount()

formatTokenAmount(params): string

Defined in: src/format/formatTokenAmount.ts:56

Formats a token balance for UI display, with optional tiny-amount and large-amount rules.

Behavior overview:

• Resolves rounding precision from display decimals, or maxDecimals / decimals
• Optionally converts raw balance from smallest units when decimals is set
• With firstNonZeroDecimal, shows enough places for dust amounts below the token minimum
• With useLargeNumberFormat, abbreviates values at/above largeNumberThreshold
• Otherwise rounds to the token's display (or on-chain) decimal places

Parameters

params

FormatTokenAmountParams

Formatting options

Returns

string

Formatted balance string, or '' when token / balance is missing or not a plain amount