Money Class

The Money class handles currency formatting, display, and mathematical operations.

Constructor

new Money(amount?: number | string, currency?: CurrencyCode)

Create a new Money instance.

Parameters:

• amount - The monetary amount (optional)
• currency - Currency code like 'USD', 'EUR', 'GBP' (optional)

Example:

const money = new Money(1234.56, 'USD');

Static Methods

setDefaultCurrency()

Money.setDefaultCurrency(currency: CurrencyCode): void

Set the default currency for all Money instances.

of()

Money.of(amount: number | string, currency?: CurrencyCode): Money

Factory method to create a Money instance.

format()

Money.format(amount: number | string, currency?: CurrencyCode): string

Format an amount as currency (static method).

whole()

Money.whole(amount: number | string, currency?: CurrencyCode): string

Format without decimal places (static method).

compact()

Money.compact(amount: number | string, currency?: CurrencyCode): string

Format in compact notation (static method).

convert()

Money.convert(amount: number | string, from: CurrencyCode, to: CurrencyCode): Promise<Money>

Convert amount between currencies (static method).

currencyCode()

Money.currencyCode(): CurrencyCode

Get the default currency code (static method).

currencySymbol()

Money.currencySymbol(): string

Get the default currency symbol (static method).

Instance Methods

Formatting Methods

format()

format(): string

Format the amount with currency symbol and proper formatting.

whole()

whole(): string

Format without decimal places.

compact()

compact(): string

Format in compact notation (K, M, B, T).

Arithmetic Methods

add()

add(other: number | string | Money): Money

Add another amount.

subtract()

subtract(other: number | string | Money): Money

Subtract another amount.

multiply()

multiply(factor: number | string | Money): Money

Multiply by a factor.

divide()

divide(divisor: number | string | Money): Money

Divide by a divisor.

Rounding Methods

round()

round(digits?: number): Money

Round to specified decimal places (default: 0).

ceil()

ceil(): Money

Round up to nearest integer.

floor()

floor(): Money

Round down to nearest integer.

Other Methods

absolute()

absolute(): Money

Get absolute value.

mod()

mod(divisor: number | string | Money): Money

Calculate modulus (remainder).

share()

share(total: number | string | Money, ratio: string | number): Money

Calculate proportional share.

convert()

convert(to: CurrencyCode): Promise<Money>

Convert to another currency.

setNegativeStyle()

setNegativeStyle(style: 'minus' | 'parentheses'): void

Set how negative amounts are displayed.

currencyCode()

currencyCode(): CurrencyCode

Get the currency code.

currencySymbol()

currencySymbol(): string

Get the currency symbol.

toString()

toString(): string

Get string representation (same as format()).

Types

CurrencyCode

type CurrencyCode = 'USD' | 'EUR' | 'GBP' | 'JPY' | /* ... many more */

Union type of all supported currency codes.

Currency

type Currency = {
  code: CurrencyCode;
  symbol: string;
};

Currency object with code and symbol.