Class Currency

Represents a currency code following ISO 4217 standard.

Currency instances are created from the CountryRegistry which provides comprehensive currency information including symbols and decimal places.

Example

const usd = Currency.USD;
const eur = Currency.EUR;
const mxn = Currency.fromCode('MXN');

Hierarchy (View Summary)

Accessors

USD EUR GBP JPY CNY CAD AUD CHF INR BRL MXN CLP COP PEN ARS

Methods

equals fromCode getCountries isMajorCurrency hasDecimals getEqualityComponents toString toJSON

Properties

code name symbol decimalPlaces

Accessors

StaticUSD

StaticEUR

StaticGBP

StaticJPY

StaticCNY

StaticCAD

StaticAUD

StaticCHF

StaticINR

StaticBRL

StaticMXN

StaticCLP

StaticCOP

StaticPEN

StaticARS

Methods

equals

  • equals(other: ValueObject): boolean

    Compares this Value Object with another for equality. Value Objects are equal if they are of the same type and all equality components match.

    Parameters

    • other: ValueObject

      The other Value Object to compare with

    Returns boolean

    true if the Value Objects are equal, false otherwise

StaticfromCode

  • fromCode(code: string): undefined | Currency

    Creates a Currency instance from a currency code. Uses data from CountryRegistry to populate currency information.

    Parameters

    • code: string

      The ISO 4217 currency code (e.g., "USD", "EUR")

    Returns undefined | Currency

    Currency instance or undefined if not found

    Example

    const currency = Currency.fromCode('MXN');
    console.log(currency?.name); // "Mexican Peso"
    console.log(currency?.symbol); // "$"

getCountries

  • getCountries(): CountryInfo[]

    Gets all countries that use this currency.

    Returns CountryInfo[]

    Array of country information

    Example

    const euro = Currency.EUR;
    const euroCountries = euro.getCountries();
    console.log(euroCountries.length); // 19+ countries

isMajorCurrency

  • isMajorCurrency(): boolean

    Checks if this is a major world currency. Major currencies are those widely used in international trade and finance.

    Returns boolean

    true if this is a major currency

hasDecimals

ProtectedgetEqualityComponents

toString

toJSON

Properties

Readonlycode

code: string

Readonlyname

name: string

Readonlysymbol

symbol: string

ReadonlydecimalPlaces

decimalPlaces: number

Settings

Member Visibility

On This Page

Accessors
Methods
Properties