acoelhosantos/currency-symbol-map

A function to lookup the currency symbol for a given currency code

currency-symbol-map

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

Installation

npm install currency-symbol-map

Usage

Get symbol from currency code

// ES5
const getSymbolFromCurrency = require('currency-symbol-map');
const safeGetSymbolFromCurrency = require('currency-symbol-map');

// ES6
import getSymbolFromCurrency from 'currency-symbol-map';
import safeGetSymbolFromCurrency from 'currency-symbol-map';

getSymbolFromCurrency('GBP'); //=> '£'
getSymbolFromCurrency('EUR'); //=> '€'
getSymbolFromCurrency('USD'); //=> '$'
getSymbolFromCurrency('NOT A VALID CODE'); //=> undefined

safeGetSymbolFromCurrency('GBP'); //=> '£'
safeGetSymbolFromCurrency('EUR'); //=> '€'
safeGetSymbolFromCurrency('USD'); //=> '$'
safeGetSymbolFromCurrency('NOT A VALID CODE'); //=> NOT A VALID CODE

Exposed map for other processing

// ES5
const currencyToSymbolMap = require('currency-symbol-map/map')

// ES6
import currencyToSymbolMap from 'currency-symbol-map/map'

console.log(currencyToSymbolMap)
// =>
{
 "USD": "$",
 "GBP": "£",
 …
}

Tests

npm test

Changelog

4.0.0

• the reverse lookup feature was removed (retrieving currency given a symbol) because there is not a deterministic way to do so (i.e. the same symbol is used by multiple currencies).
• in previous versions, an unsuccessful lookup would return the '?' character. It now returns undefined when using getSymbolFromCurrency so that it is up to you how to handle the failure, or the input as-is if safeGetSymbolFromCurrency is used.

Credits

Currency symbols originally sourced from xe, but maintained and updated by contributors.