JSPM – @depay/local-currency@3.5.0

Package Exports

@depay/local-currency
@depay/local-currency/dist/esm/index.js
@depay/local-currency/dist/umd/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@depay/local-currency) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Quickstart

yarn add @depay/local-currency

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. tests etc.):

Currency.code = 'EUR'

Development

Get started

yarn install
yarn dev

Release

npm publish