Class BitcoinExchangeRate

Index

Methods

convertToFiat fromPriceToSats getActiveFiatCurrency getDatedBitcoinExchangeRate getExchangeRate getLatestUpdate getUpdateInterval setActiveFiatCurrency setUpdateInterval getInstance

Methods

convertToFiat

convertToFiat(amounts, rate?, unit?): Promise<number[]>
Parameters
- amounts: number[]
- Optional rate: number
- unit: BitcoinUnit = 'SAT'
Returns Promise<number[]>
- Defined in util/BitcoinExchangeRate.ts:224

fromPriceToSats

fromPriceToSats(price): Promise<number>
Parameters
- price: Price
Returns Promise<number>
- Defined in util/BitcoinExchangeRate.ts:87

getActiveFiatCurrency

getActiveFiatCurrency(): FiatCurrency
Returns FiatCurrency
- Defined in util/BitcoinExchangeRate.ts:68

getDatedBitcoinExchangeRate

getDatedBitcoinExchangeRate(date, currency?): Promise<DatedRate>
Parameters
- date: Date
- Optional currency: FiatCurrency
Returns Promise<DatedRate>
- Defined in util/BitcoinExchangeRate.ts:173

getExchangeRate

getExchangeRate(forcedUpdate?): Promise<undefined | number>
Parameters
- Optional forcedUpdate: boolean
Returns Promise<undefined | number>
- Defined in util/BitcoinExchangeRate.ts:51

getLatestUpdate

getLatestUpdate(): undefined | Date
Returns undefined | Date
- Defined in util/BitcoinExchangeRate.ts:72

getUpdateInterval

getUpdateInterval(): number
Returns number
- Defined in util/BitcoinExchangeRate.ts:76

setActiveFiatCurrency

setActiveFiatCurrency(currency): void
Parameters
- currency: FiatCurrency
Returns void
- Defined in util/BitcoinExchangeRate.ts:64

setUpdateInterval

setUpdateInterval(interval): void
Parameters
- interval: number
Returns void
- Defined in util/BitcoinExchangeRate.ts:80

`Static` getInstance

getInstance(defaultFiatCurrency?, updateInterval?): BitcoinExchangeRate
Parameters
- defaultFiatCurrency: FiatCurrency = FiatCurrency.USD
- updateInterval: number = 5
Returns BitcoinExchangeRate
- Defined in util/BitcoinExchangeRate.ts:43

Generated using TypeDoc