Class Money

Staticcreate

• create(amount: number, currency: Currency): Result<Money, DomainError>

  Creates a Money instance with validation.

  Parameters

  • amount: number

    The monetary amount
  • currency: Currency

    The currency

  Returns Result<Money, DomainError>

  Success with Money or Failure with DomainError

  Example

  const result = Money.create(100, Currency.USD);
  if (result.isSuccess) {
    console.log(result.value.format()); // "$100.00"
  }
  Copy

StaticCLP

• CLP(amount: number): Money

  Creates a Money instance in Chilean Pesos.

  Parameters

  • amount: number

    The amount in Chilean Pesos

  Returns Money

  A Money instance

  Example

  const price = Money.CLP(5000);
  Copy

StaticCOP

• COP(amount: number): Money

  Creates a Money instance in Colombian Pesos.

  Parameters

  • amount: number

    The amount in Colombian Pesos.

  Returns Money

  A Money instance

  Example

  const price = Money.COP(300);
  Copy

StaticPEN

• PEN(amount: number): Money

  Creates a Money instance in Peruvian Sol.

  Parameters

  • amount: number

    The amount in Peruvian Sol.

  Returns Money

  A Money instance

  Example

  const price = Money.PEN(5000);
  Copy

StaticARS

• ARS(amount: number): Money

  Creates a Money instance in Argentine Pesos.

  Parameters

  • amount: number

    The amount in Argentine Pesos

  Returns Money

  A Money instance

  Example

  const price = Money.ARS(1000);
  Copy

StaticfromCurrencyCode

• fromCurrencyCode(
      amount: number,
      currencyCode: string,
  ): Result<Money, DomainError>

  Creates a Money instance from a currency code.

  Parameters

  • amount: number

    The monetary amount
  • currencyCode: string

    The ISO 4217 currency code

  Returns Result<Money, DomainError>

  Success with Money or Failure with DomainError

  Example

  const result = Money.fromCurrencyCode(100, 'MXN');
  if (result.isSuccess) {
    console.log(result.value.format()); // "$100.00"
  }
  Copy

StaticUSD

• USD(amount: number): Money

  Creates a Money instance in US Dollars.

  Parameters

  • amount: number

    The amount in USD

  Returns Money

  A Money instance

  Example

  const price = Money.USD(99.99);
  Copy

StaticEUR

• EUR(amount: number): Money

  Creates a Money instance in Euros.

  Parameters

  • amount: number

    The amount in EUR

  Returns Money

  A Money instance

StaticGBP

• GBP(amount: number): Money

  Creates a Money instance in British Pounds.

  Parameters

  • amount: number

    The amount in GBP

  Returns Money

  A Money instance

StaticJPY

• JPY(amount: number): Money

  Creates a Money instance in Japanese Yen.

  Parameters

  • amount: number

    The amount in JPY

  Returns Money

  A Money instance

add

• add(other: Money): Result<Money, DomainError>

  Adds another Money amount to this one. Both Money objects must have the same currency.

  Parameters

  • other: Money

    The Money to add

  Returns Result<Money, DomainError>

  Success with new Money or Failure with DomainError

  Example

  const a = Money.USD(100);
  const b = Money.USD(50);
  const result = a.add(b);
  // result.value.amount === 150
  Copy

subtract

• subtract(other: Money): Result<Money, DomainError>

  Subtracts another Money amount from this one. Both Money objects must have the same currency. Result cannot be negative.

  Parameters

  • other: Money

    The Money to subtract

  Returns Result<Money, DomainError>

  Success with new Money or Failure with DomainError

  Example

  const a = Money.USD(100);
  const b = Money.USD(30);
  const result = a.subtract(b);
  // result.value.amount === 70
  Copy

multiply

• multiply(factor: number): Money

  Multiplies this Money by a factor.

  Parameters

  • factor: number

    The multiplication factor

  Returns Money

  A new Money instance

  Example

  const price = Money.USD(10);
  const total = price.multiply(3);
  // total.amount === 30
  Copy

divide

• divide(divisor: number): Result<Money, DomainError>

  Divides this Money by a divisor.

  Parameters

  • divisor: number

    The division divisor

  Returns Result<Money, DomainError>

  Success with new Money or Failure with DomainError

  Example

  const total = Money.USD(100);
  const result = total.divide(4);
  // result.value.amount === 25
  Copy

isGreaterThan

• isGreaterThan(other: Money): boolean

  Checks if this Money is greater than another.

  Parameters

  • other: Money

    The Money to compare with

  Returns boolean

  true if this Money is greater

isLessThan

• isLessThan(other: Money): boolean

  Checks if this Money is less than another.

  Parameters

  • other: Money

    The Money to compare with

  Returns boolean

  true if this Money is less

format

• format(locale?: string): string

  Formats this Money as a string according to the locale.

  Parameters

  • locale: string = 'en-US'

    The locale to use for formatting (default: 'en-US')

  Returns string

  A formatted string representation

  Example

  const price = Money.USD(1234.56);
  console.log(price.format()); // "$1,234.56"
  console.log(price.format('de-DE')); // "1.234,56 $"
  Copy

getCountries

• getCountries(): CountryInfo[]

  Gets all countries that use this money's currency.

  Returns CountryInfo[]

  Array of country information

  Example

  const euros = Money.EUR(100);
  const countries = euros.getCountries();
  console.log(countries.map(c => c.name)); // ['France', 'Germany', ...]
  Copy

isValidForCountry

• isValidForCountry(countryCode: string): boolean

  Checks if this money's currency is used in a specific country.

  Parameters

  • countryCode: string

    The ISO2 country code

  Returns boolean

  true if the currency is used in the country

  Example

  const euros = Money.EUR(100);
  console.log(euros.isValidForCountry('FR')); // true
  console.log(euros.isValidForCountry('US')); // false
  Copy

toJSON

• toJSON(): { amount: number; currency: string }

  Returns { amount: number; currency: string }

Readonlyamount

Readonlycurrency