formatBalance

@iota/iota-sdk

---

@iota/iota-sdk / utils / formatBalance

Function: formatBalance()

formatBalance(balance, decimals, format?, showSign?, options?): string

Defined in: sdk/typescript/src/utils/formatBalance.ts:112

Formats a coin balance based on our standard coin display logic. If the balance is less than 1, it will be displayed in its full decimal form. For values greater than 1, it will be truncated to 3 decimal places.

Parameters

balance

string | number | bigint

decimals

number

format?

CoinFormat = CoinFormat.Rounded

showSign?

boolean = false

options?

FormatBalanceOptions = {}

Returns

string