Skip to main content

formatCurrencyUSD

A function that returns a string with a dollar ($) sign added to a given number or string consisting of numbers.


Code​

🔗 View source code


Interface​

typescript
function formatCurrencyUSD(
  value: number | string,
  options?: {
    decimal?: number;
  }
): string;

Usage​

Basic Usage​

typescript
import { formatCurrencyUSD } from '@modern-kit/utils';

formatCurrencyUSD(1234567);
formatCurrencyUSD('1234567');
// '$1,234,567'

formatCurrencyUSD(-1234567);
formatCurrencyUSD('-1234567');
// '-$1,234,567'

Specifying Decimal Places​

typescript
import { formatCurrencyUSD } from '@modern-kit/utils';

formatCurrencyUSD(1234567.1234, { decimal: 2 });
// '$1,234,567.12'

formatCurrencyUSD(-1234567.1234, { decimal: 2 });
// '-$1,234,567.12'