formatAmount

Utility for consistent number formatting

The formatAmount utility is designed for consistent number formatting.

Usage

code

import { formatAmount } from '@coinbase/onchainkit/token';

const amount = formatAmount('10000', { minimumFractionDigits: 2 });

Returns

string - The formatted amount.

Parameters

FormatAmountOptions

type FormatAmountOptions = {
  locale?: string; // User locale (default: browser locale)
  minimumFractionDigits?: number; // Minimum fraction digits for number decimals
  maximumFractionDigits?: number; // Maximum fraction digits for number decimals
};