Class Money

Index

Constructors

constructor

Properties

cents currency

Accessors

Methods

zero

Money

Infinity Zero abs add divide format formatRange formatWithEquivalent fromAmount getCurrencySymbol max min multiply percentage subtract toAmount toAmountString

Constructors

constructor

new Money(): Money
Returns Money

Properties

cents

cents: number

Money is not intended to be an instantiable class. We are including these properties here to allow us to use "Money as a type"

currency

currency: string

Accessors

`Static`is

get is(): {
    between: (params: { max: Money; min: Money; value: Money }) => boolean;
    equal: (money1: Money, money2: Money) => boolean;
    greaterThan: (money1: Money, money2: Money) => boolean;
    greaterThanOrEqual: (money1: Money, money2: Money) => boolean;
    lessThan: (money1: Money, money2: Money) => boolean;
    lessThanOrEqual: (money1: Money, money2: Money) => boolean;
    Money: (obj: unknown) => obj is Money;
    sameCurrency: (money1: Money, money2: Money) => boolean;
    zero: (money?: Money | null) => boolean;
    get not(): {
        between: (params: { max: Money; min: Money; value: Money }) => boolean;
        equal: (money1: Money, money2: Money) => boolean;
        Money: (obj: unknown) => boolean;
        sameCurrency: (money1: Money, money2: Money) => boolean;
        zero: (money?: Money | null) => boolean;
    };
}

Returns {
    between: (params: { max: Money; min: Money; value: Money }) => boolean;
    equal: (money1: Money, money2: Money) => boolean;
    greaterThan: (money1: Money, money2: Money) => boolean;
    greaterThanOrEqual: (money1: Money, money2: Money) => boolean;
    lessThan: (money1: Money, money2: Money) => boolean;
    lessThanOrEqual: (money1: Money, money2: Money) => boolean;
    Money: (obj: unknown) => obj is Money;
    sameCurrency: (money1: Money, money2: Money) => boolean;
    zero: (money?: Money | null) => boolean;
    get not(): {
        between: (params: { max: Money; min: Money; value: Money }) => boolean;
        equal: (money1: Money, money2: Money) => boolean;
        Money: (obj: unknown) => boolean;
        sameCurrency: (money1: Money, money2: Money) => boolean;
        zero: (money?: Money | null) => boolean;
    };
}

between: (params: { max: Money; min: Money; value: Money }) => boolean

Check if a money amount is between a minimum and maximum amount (inclusive).

Throws

If the currencies of the money amounts are different.

Example

Money.is.between({ value: { cents: 12345, currency: "USD" }, min: { cents: 12345, currency: "USD" }, max: { cents: 54321, currency: "USD" } }); // true
Money.is.between({ value: { cents: 54321, currency: "USD" }, min: { cents: 12345, currency: "USD" }, max: { cents: 54321, currency: "USD" } }); // true
Money.is.between({ value: { cents: 12345, currency: "USD" }, min: { cents: 54321, currency: "USD" }, max: { cents: 54321, currency: "USD" } }); // false
Money.is.between({ value: { cents: 54321, currency: "USD" }, min: { cents: 12345, currency: "USD" }, max: { cents: 54321, currency: "GBP" } }); // Error("Cannot perform operations on money objects in different currencies")

equal: (money1: Money, money2: Money) => boolean

Check if money1 is equal to money2.

Throws

If the currencies of the two money amounts are different.

Example

Money.is.equal({ cents: 54321, currency: "USD" }, { cents: 54321, currency: "USD" }); // true
Money.is.equal({ cents: 54321, currency: "USD" }, { cents: 54322, currency: "USD" }); // false
Money.is.equal({ cents: 54321, currency: "USD" }, { cents: 54321, currency: "GBP" }); // Error("Cannot perform operations on money objects in different currencies")

greaterThan: (money1: Money, money2: Money) => boolean

Check if money1 is greater than money2.

Throws

If the currencies of the two money amounts are different.

Example

Money.is.greaterThan({ cents: 54321, currency: "USD" }, { cents: 12345, currency: "USD" }); // true
Money.is.greaterThan({ cents: 12345, currency: "USD" }, { cents: 54321, currency: "USD" }); // false
Money.is.greaterThan({ cents: 12345, currency: "USD" }, { cents: 54321, currency: "GBP" }); // Error("Cannot perform operations on money objects in different currencies")

greaterThanOrEqual: (money1: Money, money2: Money) => boolean

Check if money1 is greater than or equal to money2.

Throws

If the currencies of the two money amounts are different.

Example

Money.is.greaterThanOrEqual({ cents: 54321, currency: "USD" }, { cents: 12345, currency: "USD" }); // true
Money.is.greaterThanOrEqual({ cents: 12345, currency: "USD" }, { cents: 54321, currency: "USD" }); // false
Money.is.greaterThanOrEqual({ cents: 12345, currency: "USD" }, { cents: 54321, currency: "GBP" }); // Error("Cannot perform operations on money objects in different currencies")

lessThan: (money1: Money, money2: Money) => boolean

Check if money1 is less than money2.

Throws

If the currencies of the two money amounts are different.

Example

Money.is.lessThan({ cents: 54321, currency: "USD" }, { cents: 12345, currency: "USD" }); // false
Money.is.lessThan({ cents: 12345, currency: "USD" }, { cents: 54321, currency: "USD" }); // true
Money.is.lessThan({ cents: 12345, currency: "USD" }, { cents: 54321, currency: "GBP" }); // Error("Cannot perform operations on money objects in different currencies")

lessThanOrEqual: (money1: Money, money2: Money) => boolean

Check if money1 is less than or equal to money2.

Throws

If the currencies of the two money amounts are different.

Example

Money.is.lessThanOrEqual({ cents: 54321, currency: "USD" }, { cents: 12345, currency: "USD" }); // false
Money.is.lessThanOrEqual({ cents: 12345, currency: "USD" }, { cents: 54321, currency: "USD" }); // true
Money.is.lessThanOrEqual({ cents: 12345, currency: "USD" }, { cents: 54321, currency: "GBP" }); // Error("Cannot perform operations on money objects in different currencies")

Money: (obj: unknown) => obj is Money

Type guard to check if an object is a Money object.

Example

Money.is.Money({ cents: 100, currency: "USD" }); // true
Money.is.Money({ amount: 100, currency: "USD" }); // false

sameCurrency: (money1: Money, money2: Money) => boolean

Check if money1 and money2 are in the same currency.

Example

Money.is.sameCurrency({ cents: 54321, currency: "USD" }, { cents: 54321, currency: "USD" }); // true
Money.is.sameCurrency({ cents: 54321, currency: "USD" }, { cents: 54321, currency: "GBP" }); // false

zero: (money?: Money | null) => boolean

Check if money is zero.

Example

Money.is.zero({ cents: 0, currency: "USD" }); // true
Money.is.zero({ cents: 2, currency: "USD" }); // false
Money.is.zero(null); // true
Money.is.zero(undefined); // true

get not(): {
    between: (params: { max: Money; min: Money; value: Money }) => boolean;
    equal: (money1: Money, money2: Money) => boolean;
    Money: (obj: unknown) => boolean;
    sameCurrency: (money1: Money, money2: Money) => boolean;
    zero: (money?: Money | null) => boolean;
}

Methods

`Static`zero

zero(currency: string): Money
Returns a zero money object in the given currency.
Parameters
- currency: string
  The currency code.
Returns Money
A money object with 0 cents in the specified currency.
Example
```
Money.zero("EUR"); // { cents: 0, currency: "EUR" }
```
- Defined in utils/money/Money.ts:46

Money

`Static`Infinity

Infinity: Money = ...

The infinity money object.

Example

Money.Infinity; // { cents: Infinity, currency: "USD" }

`Static`Zero

Zero: Money = ...

The zero money object.

Example

Money.Zero; // { cents: 0, currency: "USD" }

`Static`abs

abs(money: Money): Money
Gets absolute value of a money object.
Parameters
- money: Money
  The money object.
Returns Money
The absolute value of the money object.
Example
```
Money.abs({ cents: -12345, currency: "USD" }); // { cents: 12345, currency: "USD" }
```
- Defined in utils/money/Money.ts:305

`Static`add

add(...monies: Money[]): Money

Add two or more money objects.

Parameters

...monies: Money[]
The money objects.

Returns Money

The result of adding the money objects.

Throws

If the currencies of the money amounts are different.

Example

Money.add({ cents: 54321, currency: "USD" }, { cents: 12345, currency: "USD" }); // { cents: 66666, currency: "USD" }
Money.add({ cents: 54321, currency: "USD" }, { cents: 12345, currency: "USD" }, { cents: 11, currency: "USD" }); // { cents: 66677, currency: "USD" }
Money.add({ cents: 54321, currency: "GBP" }, { cents: 0, currency: "USD" }); // { cents: 54321, currency: "GBP" }
Money.add({ cents: 54321, currency: "GBP" }, { cents: 10, currency: "USD" }); // Error("Cannot perform operations on money objects in different currencies")

`Static`divide

divide(money: Money, divisor: number): Money
Divide a money object by a divisor.
Parameters
- money: Money
  The money object.
- divisor: number
  The divisor.
Returns Money
The result of dividing the money object by the divisor.
Example
```
Money.divide({ cents: 12345, currency: "USD" }, 2); // { cents: 6173, currency: "USD" }
Money.divide({ cents: 12345, currency: "USD" }, 0); // Error("Cannot divide by zero")
```
- Defined in utils/money/Money.ts:393

`Static`format

format(money: Money, options?: MoneyFormatOptions): string

Formats a money object.

Parameters

money: Money
The money object to be formatted.
Optionaloptions: MoneyFormatOptions
The options for formatting.

Returns string

The formatted currency.

Example

Money.format({ cents: 123456, currency: "USD" }); // "$1,234.56 USD"
Money.format({ cents: 123456, currency: "GBP" }); // "£1,234.56 EUR"
Money.format({ cents: 123456, currency: "JPY" }); // "¥123,456 JPY"
Money.format({ cents: 123456, currency: "USD" }, { showCents: false }); // "$1,234 USD"
Money.format({ cents: 123456, currency: "USD" }, { showCurrency: false }); // "$1,234.56"
Money.format({ cents: 123456, currency: "EUR" }, { locale: "de-DE" }); // "1.234,56 € EUR"
Money.format({ cents: 123456, currency: "EUR" }, { locale: "de" }); // "1.234,56 € EUR"
Money.format({ cents: 150_000, currency: "EUR" }, { compact: true, locale: "de", showCents: false }); // "1.5k € EUR"
Money.format({ cents: 150_000, currency: "USD" }, { compact: true, showCents: false }); // "$1.5K USD"

`Static`formatRange

formatRange(min: Money, max: Money, options?: MoneyFormatOptions): string
Formats a range of two money objects, showing the currency only once at the end. Useful for displaying min-max ranges without duplicating currency symbols.
Parameters
- min: Money
  The minimum money object.
- max: Money
  The maximum money object.
- Optionaloptions: MoneyFormatOptions
  The options for formatting.
Returns string
The formatted currency range.
Example
```
Money.formatRange({ cents: 50000, currency: "USD" }, { cents: 500000, currency: "USD" }, { compact: true }); // "$500 - $5K USD"
Money.formatRange({ cents: 50000, currency: "AED" }, { cents: 500000, currency: "AED" }, { compact: true }); // "500 - 5K AED"
Money.formatRange({ cents: 50000, currency: "USD" }, { cents: 50000, currency: "USD" }); // "$500.00 USD"
```
- Defined in utils/money/Money.ts:131

`Static`formatWithEquivalent

formatWithEquivalent(
    money: Money,
    equivalentMoney: Money | null | undefined,
    options?: MoneyFormatOptions,
): string
Formats a money object with an equivalent amount in another currency shown in parentheses. If the two amounts share the same currency, or if equivalentMoney is null/undefined, only the primary amount is shown.
Parameters
- money: Money
  The primary money object to format.
- equivalentMoney: Money | null | undefined
  The equivalent amount in another currency.
- Optionaloptions: MoneyFormatOptions
  The options for formatting both amounts.
Returns string
The formatted string.
Example
```
Money.formatWithEquivalent({ cents: 100_00, currency: "CAD" }, { cents: 75_00, currency: "USD" }); // "$100.00 CAD ($75.00 USD)"
Money.formatWithEquivalent({ cents: 100_00, currency: "USD" }, { cents: 100_00, currency: "USD" }); // "$100.00 USD"
Money.formatWithEquivalent({ cents: 100_00, currency: "USD" }, null); // "$100.00 USD"
```
- Defined in utils/money/Money.ts:177

`Static`fromAmount

fromAmount(
    amount: string | number,
    currency?: string,
    options?: { locale?: LocalesArgument },
): Money
Converts a number or string amount to a money object.
Parameters
- amount: string | number
  The amount.
- currency: string = Currency.USD
  The currency code.
- Optionaloptions: { locale?: LocalesArgument }
  Optional parameters.
  - Optionallocale?: LocalesArgument
    The locale to use for formatting.
Returns Money
The money object.
Example
```
Money.fromAmount(123.45, "USD"); // { cents: 12345, currency: "USD" }
Money.fromAmount("123.45", "USD"); // { cents: 12345, currency: "USD" }
Money.fromAmount(123.45, "CAD"); // { cents: 12345, currency: "CAD" }
Money.fromAmount(123.45, "USD", { locale: "en-US" }); // { cents: 12345, currency: "USD" }
```
- Defined in utils/money/Money.ts:236

`Static`getCurrencySymbol

getCurrencySymbol(
currency: string,
options?: { locale?: LocalesArgument },
): string
Returns a given currency symbol
Parameters
- currency: string
  The currency code, e.g: "USD"
- options: { locale?: LocalesArgument } = {}
  The options for getting the currency symbol.
  - Optionallocale?: LocalesArgument
    The locale to use for formatting
Returns string
The currency symbol.
Example
```
Money.getCurrencySymbol("USD"); // "$"
Money.getCurrencySymbol("EUR"); // "€"
Money.getCurrencySymbol("AUD"); // "د.إ"
```
- Defined in utils/money/Money.ts:202

`Static`max

max(...monies: Money[]): Money

Get the maximum of two or more money objects.

Parameters

...monies: Money[]
The money objects.

Returns Money

The maximum money object.

Throws

If no money objects are provided.

Throws

If the currencies of the money amounts are different.

Example

Money.max({ cents: 100, currency: "USD" }, { cents: 200, currency: "USD" }) // { cents: 200, currency: "USD" }
Money.max({ cents: 100, currency: "USD" }, { cents: 300, currency: "USD" }, { cents: 200, currency: "USD" }) // { cents: 300, currency: "USD" }
Money.max({ cents: 100, currency: "USD" }, { cents: 100, currency: "GBP" }) // Error("Cannot perform operations on money objects in different currencies")

`Static`min

min(...monies: Money[]): Money

Get the minimum of two or more money objects.

Parameters

...monies: Money[]
The money objects.

Returns Money

The minimum money object.

Throws

If no money objects are provided.

Throws

If the currencies of the money amounts are different.

Example

Money.min({ cents: 100, currency: "USD" }, { cents: 200, currency: "USD" }) // { cents: 100, currency: "USD" }
Money.min({ cents: 100, currency: "USD" }, { cents: 300, currency: "USD" }, { cents: 200, currency: "USD" }) // { cents: 200, currency: "USD" }
Money.min({ cents: 100, currency: "USD" }, { cents: 100, currency: "GBP" }) // Error("Cannot perform operations on money objects in different currencies")

`Static`multiply

multiply(money: Money, multiplier: number): Money
Multiply a money object by a multiplier.
Parameters
- money: Money
  The money object.
- multiplier: number
  The multiplier.
Returns Money
The result of multiplying the money object by the multiplier.
Example
```
Money.multiply({ cents: 12345, currency: "USD" }, 2); // { cents: 24690, currency: "USD" }
Money.multiply({ cents: 12345, currency: "USD" }, 2.7); // { cents: 33332, currency: "USD" }
```
- Defined in utils/money/Money.ts:376

`Static`percentage

percentage(part: Money, whole: Money): number
Calculate the percentage of one Money object relative to another.
Parameters
- part: Money
  The part Money object.
- whole: Money
  The whole Money object.
Returns number
The calculated percentage as a string.
Throws
If the currencies of the two money amounts are different.
Example
```
Money.percentage({ cents: 5000, currency: "USD" }, { cents: 10000, currency: "USD" }); // "50.0"
Money.percentage({ cents: 5000, currency: "USD" }, { cents: 10000, currency: "GBP" }); // Error("Cannot perform operations on money objects in different currencies")
```
- Defined in utils/money/Money.ts:415

`Static`subtract

subtract(money1: Money, money2: Money): Money

Subtract money2 from money1.

Parameters

money1: Money
The first money object.
money2: Money
The second money object.

Returns Money

The result of subtracting money2 from money1.

Throws

If the currencies of the two money amounts are different.

Example

Money.subtract({ cents: 54321, currency: "USD" }, { cents: 12345, currency: "USD" }); // { cents: 41976, currency: "USD" }
Money.subtract({ cents: 54321, currency: "EUR" }, { cents: 12345, currency: "USD" }); // Error("Cannot perform operations on money objects in different currencies")

`Static`toAmount

toAmount(money: Money, options?: { locale?: LocalesArgument }): number
Converts a money object to an amount.
Parameters
- money: Money
  The money object.
- Optionaloptions: { locale?: LocalesArgument }
  Optional parameters.
  - Optionallocale?: LocalesArgument
    The locale to use for formatting.
Returns number
The amount.
Example
```
Money.toAmount({ cents: 12345, currency: "USD" }); // 123.45
Money.toAmount({ cents: 123456, currency: "EUR" }, { locale: "de-DE" }); // "1.234,56 €"
```
- Defined in utils/money/Money.ts:269

`Static`toAmountString

toAmountString(money: Money | null | undefined): string
Converts a money object to a string amount.
Parameters
- money: Money | null | undefined
  The money object.
Returns string
The string amount.
Example
```
Money.toAmountString({ cents: 12345, currency: "USD" }); // "123.45"
Money.toAmountString(null); // ""
Money.toAmountString(undefined); // ""
```
- Defined in utils/money/Money.ts:293

Class Money

Index

Constructors

Properties

Accessors

Methods

Money

Constructors

constructor

Returns Money

Properties

cents

currency

Accessors

Staticis

between: (params: { max: Money; min: Money; value: Money }) => boolean

Throws

Example

equal: (money1: Money, money2: Money) => boolean

Throws

Example

greaterThan: (money1: Money, money2: Money) => boolean

Throws

Example

greaterThanOrEqual: (money1: Money, money2: Money) => boolean

Throws

Example

lessThan: (money1: Money, money2: Money) => boolean

Throws

Example

lessThanOrEqual: (money1: Money, money2: Money) => boolean

Throws

Example

Money: (obj: unknown) => obj is Money

Example

sameCurrency: (money1: Money, money2: Money) => boolean

Example

zero: (money?: Money | null) => boolean

Example

get not(): { between: (params: { max: Money; min: Money; value: Money }) => boolean; equal: (money1: Money, money2: Money) => boolean; Money: (obj: unknown) => boolean; sameCurrency: (money1: Money, money2: Money) => boolean; zero: (money?: Money | null) => boolean;}

Methods

Staticzero

Parameters

Returns Money

Example

Money

StaticInfinity

Example

StaticZero

Example

Staticabs

Parameters

Returns Money

Example

Staticadd

Parameters

Returns Money

Throws

Example

Staticdivide

Parameters

Returns Money

Example

Staticformat

Parameters

Returns string

Example

StaticformatRange

Parameters

Returns string

Example

StaticformatWithEquivalent

Parameters

Returns string

Example

StaticfromAmount

Parameters

Optionallocale?: LocalesArgument

Returns Money

Example

`Static`is

get not(): {
between: (params: { max: Money; min: Money; value: Money }) => boolean;
equal: (money1: Money, money2: Money) => boolean;
Money: (obj: unknown) => boolean;
sameCurrency: (money1: Money, money2: Money) => boolean;
zero: (money?: Money | null) => boolean;
}

`Static`zero

`Static`Infinity

`Static`Zero

`Static`abs

`Static`add

`Static`divide

`Static`format

`Static`formatRange

`Static`formatWithEquivalent

`Static`fromAmount

`Optional`locale?: LocalesArgument

`Static`getCurrencySymbol

`Optional`locale?: LocalesArgument

`Static`max

`Static`min

`Static`multiply

`Static`percentage

`Static`subtract

`Static`toAmount

`Optional`locale?: LocalesArgument

`Static`toAmountString