depay-local-currencydeprecated

JavaScript library that detects user's currency and provides functionalities to convert between multiple currencies.

Usage no npm install needed!

<script type="module">
  import depayLocalCurrency from 'https://cdn.skypack.dev/depay-local-currency';
</script>

README

Quickstart

yarn add depay-local-currency

or

npm install --save depay-local-currency

import { Currency } from 'depay-local-currency'

let currency = new Currency({ amount: 20 })
currency.toString()
// €22.32

Functionalities

new Currency

Creates an instance of Currency

let currency = new Currency({ amount: 20 })

amount sets the amount you want to convert into a currency string.

timeZone will be automatically detected by the client, but can be provided to:

let currency = new Currency({ amount: 20, timeZone: 'Europe/Berlin' })

toString

Converts a currency string into a formatted string:

let currency = new Currency({ amount: 20 })
currency.toString()
// €22.32

fromUSD

Converts USD into local currency:

let currency = await Currency.fromUSD({ amount: 20, apiKey: 'MY-API-KEY' })
currency.toString()
// €16.88

Requires you to pass an apiKey in order to convert currencies!

See: https://depay.fi/documentation/api#fiat

Development

Get started

yarn install
yarn dev

Release

npm publish