formatUnits

formatUnits(value, decimals): string

Defined in: utils/format-units.ts:30

Format a value in the smallest unit (e.g. wei) as a decimal string with the given number of decimal places.

Similar to “formatUnits” in ethers.js

Similar to “formatUnits” in viem

Parameters

value

the value to format (in smallest unit)

string | number | bigint

decimals

number = 18

the number of decimal places (default 18)

Returns

string

a decimal string representation

Examples

formatUnits(1000000n, 6)
// '1'

formatUnits('1000000000000000000', 18)
// '1'

formatUnits(1500000n, 6)
// '1.5'