@swapped/connect-sdk / format / FormatTokenAmountParams

Type Alias: FormatTokenAmountParams

FormatTokenAmountParams = object

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

Properties

balance

balance: string | number | null | undefined

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

Raw smallest-unit balance, or human amount when decimals is omitted.

---

decimals?

optional decimals?: number

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

Token decimals; when set, treats balance as smallest units.

---

display?

optional display?: boolean

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

When true (default), round to the token’s display decimals. When false, round to maxDecimals, or decimals if maxDecimals is omitted.

---

firstNonZeroDecimal?

optional firstNonZeroDecimal?: boolean

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

For amounts below the token minimum, show through the first non-zero decimal digit instead of rounding to the usual display precision.

---

largeNumberThreshold?

optional largeNumberThreshold?: number

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

Threshold for compact format. Defaults to 10000 when omitted.

---

maxDecimals?

optional maxDecimals?: number

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

Rounding precision when display is false. Required in that mode unless decimals is also set.

---

network?

optional network?: Network

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

Network used when resolving display decimals. Omit when unknown.

---

token

token: TokenSymbol | undefined | null

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

Token symbol used to look up decimals / min display amount.

---

useLargeNumberFormat?

optional useLargeNumberFormat?: boolean

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

Enable compact K/M formatting for large amounts.