constructor

• new MonetaryAmount(
      amount: string | number | bigint | Fee,
      currency: string,
  ): MonetaryAmount

  Constructs a monetary amount from an exact fee and currency.

  amount accepts a Fee value object or a DecimalInput. currency uses the same validated asset-string contract as instrument assets.

  Errors

  Throws ParamError on an invalid fee or AssetError on an invalid currency.

  Parameters

  • amount: string | number | bigint | Fee
  • currency: string

  Returns MonetaryAmount

Readonlyamount

Readonlycurrency

[dispose]

• "[dispose]"(): void

  Returns void

clone

• clone(): MonetaryAmount

  Returns a fresh monetary amount holding the same amount and currency.

  Returns MonetaryAmount

equals

• equals(other: MonetaryAmount): boolean

  Returns true when both the amount and currency are equal.

  Parameters

  • other: MonetaryAmount

  Returns boolean

free

• free(): void

  Returns void