README.md

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

options: accepts options object that will be forwarded to Intl.NumberFormat

new LocalCurrency.Currency({ amount: 20 }).toString({ minimumFractionDigits: 0 })
// $20

fromUSD

Converts USD into local currency:

let currency = await Currency.fromUSD({ amount: 20 })
currency.toString()
// €16.88

rate

Gets rate for given from and to:

let rate = await Currency.rate({ from: 'EUR', to: 'GBP' })
// 1.1585365853658536

getCode

Gives you the local currency code:

Currency.getCode()
// EUR

set currency globally

e.g. in tests etc.:

window._LocalCurrencyCode = 'EUR'

Development

Get started

yarn install
yarn dev

Release

npm publish