Class Money

constructor

• new Money(value?: MoneyParameter): Money

  Parameters

  • value: MoneyParameter = "0"

  Returns Money

Readonlyvalue

format

• format(format?: MoneyFormatOptions): string

  format a price amount. extend # of decimals to specified # if not enough

  Parameters

  • Optionalformat: MoneyFormatOptions

  Returns string

toJSON

• toJSON(): string

  Returns string

toNumber

• toNumber(): number

  Returns number

toString

• toString(): string

  Returns string

Staticadd

• add(left: MoneyParameter, ...right: MoneyParameter[]): Money

  Adds numbers together

  Parameters

  • left: MoneyParameter
  • ...right: MoneyParameter[]

  Returns Money

Staticcheck

• check(
      left: MoneyParameter,
      relation: MoneyTestTypes,
      right: MoneyParameter,
  ): boolean

  Test whether two values have a specific relation

  Parameters

  • left: MoneyParameter
  • relation: MoneyTestTypes

    One of '<', '<=', '==', '!=', '>', '>=''
  • right: MoneyParameter

  Returns boolean

  TRUE if the relation holds

  Example

  console.log(Money.check(1, '\<', 2)); // prints 'true'
  Copy

Staticcmp

• cmp(left: MoneyParameter, right: MoneyParameter): -1 | 0 | 1

  Compares two numbers

  Parameters

  • left: MoneyParameter
  • right: MoneyParameter

  Returns -1 | 0 | 1

  Returns 0 if amount1 === amount2, -1 if amount1 < amount2, 1 if amount1 > amount2

Staticdivide

• divide(numerator: MoneyParameter, divider: MoneyParameter): Money

  Divides two values, (currently with up to 5 decimals of precision)

  Parameters

  • numerator: MoneyParameter

    Value to divide
  • divider: MoneyParameter

  Returns Money

  Divided value

StaticfromNumber

• fromNumber(value: number): Money

  Parameters

  • value: number

  Returns Money

StaticgetPercentage

• getPercentage(amount: MoneyParameter, percentage: MoneyParameter): Money

  Returns a percentage of an amount

  Parameters

  • amount: MoneyParameter

    Original amount
  • percentage: MoneyParameter

  Returns Money

  Percentage of the amount

StaticisMoney

• isMoney(value: unknown): value is Money

  Parameters

  • value: unknown

  Returns value is Money

Staticmax

• max(amount: MoneyParameter, ...amounts: MoneyParameter[]): Money

  Returns the maximum of all the arguments

  Parameters

  • amount: MoneyParameter

    First value
  • ...amounts: MoneyParameter[]

    Rest of the values

  Returns Money

  The highest value among amount and amounts

Staticmin

• min(amount: MoneyParameter, ...amounts: MoneyParameter[]): Money

  Returns the minimum of all the arguments

  Parameters

  • amount: MoneyParameter

    First value
  • ...amounts: MoneyParameter[]

    Rest of the values

  Returns Money

  The lowest value among amount and amounts

Staticmultiply

• multiply(left: MoneyParameter, right: MoneyParameter): Money

  Multiplies two numbers together

  Parameters

  • left: MoneyParameter
  • right: MoneyParameter

  Returns Money

StaticroundToMultiple

• roundToMultiple(
      amount: MoneyParameter,
      roundto: MoneyParameter,
      mode: MoneyRoundingMode,
  ): Money

  Rounds a value to a multiple of a unit, with a specific rounding mode

  Parameters

  • amount: MoneyParameter
  • roundto: MoneyParameter
  • mode: MoneyRoundingMode

    Rounding mode. Possible values:
    

    • none: No rounding
    • toward-zero: Round toward zero
    • down: Round toward negative infity
    • up: Round toward positive infity
    • half-toward-zero: Round nearest multiple, round half of a multiple toward zero
    • half-down: Round nearest multiple, round half of a multiple toward negative infinity
    • half-up: Round nearest multiple, round half of a multiple toward positive infity

  Returns Money

  The rounded value

Staticsubtract

• subtract(left: MoneyParameter, right: MoneyParameter): Money

  Subtracts a number from another number

  Parameters

  • left: MoneyParameter
  • right: MoneyParameter

  Returns Money