@coinify/currency

Helper functions for managing amounts in different currencies

Usage no npm install needed!

<script type="module">
  import coinifyCurrency from 'https://cdn.skypack.dev/@coinify/currency';
</script>

README

node-currency

npm version

Installation

Run the following command

npm install --save @coinify/currency

Usage

const currency = require('@coinify/currency');

currency exposes the following functions:

getDecimalsForCurrency(currency)

Returns the number of decimals after the floating point, with which the amount should be formatted, depending on the currency.

fromSmallestSubunit(amount, currency)

Convert an amount of money from the smallest sub-unit of the currency to the main-unit.

toSmallestSubunit(amount, currency)

Convert an amount of money from the main-unit of the currency to the smallest sub-unit.

convertSubunitAmount(amountSubUnit, rate, fromCurrency, toCurrency)

Convert between sub-unit amounts of two currencies with a given rate, correctly converting between sub-units with different decimal amounts.

computeRateBetweenSubunitAmounts(fromCurrency, fromAmount, toCurrency, toAmount)

Computes a rate between two amounts in two different currencies.

isValidCurrency(code)

Is the provided currency code a valid currency? (fiat or crypto)

isValidFiatCurrency(code)

Is the provided currency code a valid fiat currency?

isValidCryptoCurrency(code)

Is the provided currency code a valid crypto currency?