Class CryptoCurrency

A class for storing an API cryptocurrency.

Hierarchy

Currency
- CryptoCurrency

Index

Constructors

Properties

code explorer format icon name

Methods

convertByExchangeRate convertFromRaw convertToRaw

Constructors

constructor

new CryptoCurrency(payload): CryptoCurrency
Create a CryptoCurrency.
Parameters
- payload: APICryptoCurrency
  
  The currency from the API
Returns CryptoCurrency
Overrides Currency.constructor
- Defined in src/structures/Currency.ts:74

Properties

code

code: string

The currency code

explorer

explorer: string

The currency explorer link

format

format: CurrencyFormat

An instance of CurrencyFormat for this currency

icon

icon: string

The currency icon link

name

name: string

The currency name

Methods

convertByExchangeRate

convertByExchangeRate(value, exchangeRate): null | BigNumber
Convert the value in this currency to USD as a BigNumber.
Parameters
- value: BigNumber
- exchangeRate: ExchangeRate
Returns null | BigNumber
Inherited from Currency.convertByExchangeRate
- Defined in src/structures/Currency.ts:49

convertFromRaw

convertFromRaw(value): BigNumber
Convert a raw value to a BigNumber in human readable format.
Parameters
- value: BigNumber
  
  The raw value
Returns BigNumber
Inherited from Currency.convertFromRaw
- Defined in src/structures/Currency.ts:34

convertToRaw

convertToRaw(value): BigNumber
Convert a BigNumber value in human readable format to a raw API BigNumber.
Parameters
- value: BigNumber
  
  The amount
Returns BigNumber
Inherited from Currency.convertToRaw
- Defined in src/structures/Currency.ts:42