Class Amount

constructor

• new Amount(payload, client?): Amount

• Create an Amount.

  Parameters

  • payload: APIMonetary | APICoin

    An amount from the API

  • Optional client: TipccClient

  Returns Amount

client

currencyCode

valueRaw

currency

• get currency(): null | CryptoCurrency | FiatCurrency

• The currency

  Returns null | CryptoCurrency | FiatCurrency

emoji

• get emoji(): null | string

• The currency emoji (Discord Formatted)

  Returns null | string

usdValue

• get usdValue(): null | BigNumber

• The USD value

  Returns null | BigNumber

value

• get value(): null | BigNumber

• The value

  Returns null | BigNumber

add

• add(value): boolean

• Parameters

  • value: BigNumber

  Returns boolean

addRaw

• addRaw(value): void

• Parameters

  • value: BigNumber

  Returns void

subtract

• subtract(value): boolean

• Parameters

  • value: BigNumber

  Returns boolean

subtractRaw

• subtractRaw(value): void

• Parameters

  • value: BigNumber

  Returns void

toString

• toString(includeUsd?): null | string

• Parameters

  • includeUsd: boolean = true

  Returns null | string