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

1// ES5
2const getSymbolFromCurrency = require('currency-symbol-map')
3
4// ES6
5import getSymbolFromCurrency from 'currency-symbol-map'
6
7getSymbolFromCurrency('GBP') //=> '£'
8getSymbolFromCurrency('EUR') //=> '€'
9getSymbolFromCurrency('USD') //=> '$'
10getSymbolFromCurrency('NOT A VALID CODE') //=> undefined

Exposed map for other processing

1// ES5
2const currencyToSymbolMap = require('currency-symbol-map/map')
3
4// ES6
5import currencyToSymbolMap from 'currency-symbol-map/map'
6
7console.log(currencyToSymbolMap)
8// =>
9{
10 "USD": "$",
11 "GBP": "£",
12 …
13}

Tests

1npm test

Changelog

5.1.0

• Add CNH Currency mapping: #82

5.0.1

• upgraded linter and improved code formatting (#63)

5.0.0

• added some missing currencies (#61)
• fixed the BTC symbol (#50)
• fixed the KZT symbol (#52)
• fixed the SGD symbol (#55)
• added TypeScript typings (#53)
• upgraded test libraries & added extra test cases (#62)

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 so that it is up to you how to handle the failure.

Credits

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