4.0.0 • Published 8 years ago

currency-symbol-mapper v4.0.0

Weekly downloads
3
License
BSD-2-Clause
Repository
github
Last release
8 years ago

currency-symbol-map

A function to lookup the currency symbol for a given currency code and vice versa.

Installation

npm install currency-symbol-mapper

Usage

Get symbol from currency code

var getSymbolFromCurrency = require('currency-symbol-map').getSymbolFromCurrency;
getSymbolFromCurrency('GBP'); //=> '£'
getSymbolFromCurrency('EUR'); //=> '€'
getSymbolFromCurrency('USD'); //=> '$'
getSymbolFromCurrency('NOT A VALID CODE'); //=> undefined

Get currency code from symbol

var getCurrencyFromSymbol = require('currency-symbol-map').getCurrencyFromSymbol;
getCurrencyFromSymbol('£'); //=> 'GBP'
getCurrencyFromSymbol('€'); //=> 'EUR'
getCurrencyFromSymbol('$'); //=> 'USD'
getCurrencyFromSymbol('NOT A VALID CODE'); //=> undefined

Exposed maps for other processing

var symbolCurrencyMap = require('currency-symbol-map').symbolCurrencyMap;
/*
{
  "$": "USD",
  "£": "GBP",
  ...
}
*/

var currencySymbolMap = require('currency-symbol-map').currencySymbolMap;
/*
{
  "USD": "$",
  "GBP": "£",
  ...
}
*/

Shorthand usage

var getSymbol = require('currency-symbol-map')
getSymbol('GBP') //=> '£'
getSymbol('EUR') //=> '€'
getSymbol('USD') //=> '$'
getSymbol('NOT A VALID CODE') //=> '?'

Tests

npm test

Credits

Forked from project maintained by Ben Gourley (https://github.com/bengourley/currency-symbol-map).