bengourley / 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')

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

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

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

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.

currency-symbol-map's Issues

BTC Symbol wrong

Hi @bengourley,
I think BTC symbol is ₿

Currency name

I think it would be good to add a function to get the currency name as well as the symbol.

Maybe add a getNameFromCurrency function that would return the name based on the currency code, and another one (e.g. getCurrency) that would get both the symbol and the name (e.g. {symbol: '$', name: 'US Dollar'}).

I would be willing to create a PR if you like the idea.

CHF

Great map, guys! Just FYI, the one symbol you are missing, the Swiss franc (CHF) is commonly abbreviated Fr in Switzerland.

Not a 1-1 mapping between currencies and symbols

While I was reviewing the tests for #22, I noticed an issue. @bestan this relates to the work you did to implement the reverse mapping from symbols back to currencies (#13).

I don't if it was the situation at the time (I haven't checked) but it certainly is the case now – there's a 1-many mapping between symbols and currency codes. This means working out the code from the symbol is non-deterministic. Because of the way it's implemented, the actual implementation chooses the last code to have been added to the map.

So for example before the changes in #22:

getCurrencyFromSymbol('$') === 'USD'

and after:

getCurrencyFromSymbol('$') === 'XCD'

Any thoughts @bestan?

AUD symbol incorrect

currency-symbol-map/map.js

Line 9 in e952bf8

AUD: '$',

should be AU$ instead of simple $
https://en.wikipedia.org/wiki/Australian_dollar

Not usable via CDN

I have a Shopify site where I need to dynamically convert from a currency code to a symbol. However being in Shopify I can't use NPM modules.

I'm happy to do a PR for a webpack build so that this library can be used via a CDN.

Symbol left or right?

Would be great if you could get a symbol object with say {left: '', right: '€'} or {left: '£', right: ''}. So you could write:
getSymbolFromCurrency('GBP'); //=> {left: '£', right: ''}

License

Would you be willing to attach a license to this code (preferably MIT)?

Thanks!

What about BTC symbols?

Hey guys, would you mind adding BTC symbol mapping as well.

Package pulled from npm is missing "TRY" symbol

I have zero idea why

Tried on OSX 10.11.5 and and on Ubuntu Ubuntu 14.04.4 LTS vagrant (hosted by osx)

$ npm --version
3.9.5

ping me if you want more details.

Thanks

3.1.0 tagged release does not have latest map

It doesn't seem like v3.1.0 tagged release has the latest map. i.e. latest master map has BHD, but 3.1.0 tagged release does not have it. Please let me know. Thanks!

Throwing a TypeError when input isn't string

How about throwing a TypeError when input isn't a string? Currently getSymbolFromCurrency(1) returns undefined, but it seems very likely that it would only be due to programmer error that something non-string was submitted.

I'd be happy to submit a PR if you want it 🙌

Can u add Get symbols from local code ( 2 char code also the country name )

• Get symbols using local code ( 2 char code eg: "fr - france" )
• Also available the country name.

UZS currency symbol is wrong

for UZS symbol now is 'лв', but must be 'so'm'

Some symbols are different with XE

Hi team,

This repo is really helpful for me. Thank you guys. Found a small issue, seems some symbols are different with XE, please see following list,

Code	Symbol here	Symbol in XE
AZN	₼	ман
BOB	Bs.	$b
CHF	Fr.	CHF
KZT	₸	лв

CommonJS or AMD dependencies can cause optimization bailouts

Can this project add support of ESmodules?

I get in my application constantly errors like CommonJS or AMD dependencies can cause optimization bailouts

ES6 Documentation

I'm currently using this in a project written in ES6 / ECMAScript2015. If you'd like, I can add an ES6 usage example to the docs.

ES6 modules import within a native ES modules library, Rollup setup

hi guys!

Has anybody been able to successfully consume this library in another, native ES modules-code library? I quickly browsed through dependents on npm but none seem to be natively in ES modules.

I'm rewriting one of my libs that consumes this library to be in ES modules and I'm having trouble with Rollup. It does not recognise currency-symbol-map/map (imported by src/util.js) (as per readme instructions):

I am following the readme instructions though, import currencyToSymbolMap from 'currency-symbol-map/map'

Looking at the setup of this library, I find it strange. Correct me if I'm wrong, but in order to properly support ES modules library should be rewritten in ES modules and end-file path to be wired up to module key in package.json. For that you need Rollup and Babel plugin and transpile a copy to CommonJS and wire up as main in package.json.

For a proper ES modules setup it's not enough just to wire it up via module.exports in main JS file, is it?

---

For the record I'm not a Rollup n00b, I have published whole chains of open source native ES module libraries consuming other libraries and I'm following Rollup template. If I can't get it working others probably can't either (or they probably haven't jumped onto ES modules bandwagon yet).

---

On the positive side, that's an awesome library.

cheers
Roy

PYG symbol incorrect

currency-symbol-map/map.js

Line 130 in e952bf8

PYG: 'Gs',

should be ₲ wikipedia: Paraguayan guaraní

Cents and pence?

Is it possible to get the smaller unit symbol too? Like USD has cents and GBP has pence?

Type not found for currency-symbol-map/map

Hi,

When importing all currency symbols:

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

I have a type error, module file declaration 'currency-symbol-map/map' not found.

I added this declaration in my project:

type CurrencySymbolMapMap = {
  [index: string]: string;
};
declare module 'currency-symbol-map/map' {
  import data from 'currency-symbol-map/map';

  export default data as CurrencySymbolMapMap;
}

It seems to work, but is it possible to include an "official" declaration directly in the module?

Thank you for your fantastic module :)

Currency symbols displays as empty squares in chrome (windows only)

I'm using this package at client-side as browser script via browserify.
It works fine for Linux and Mac (tested in chrome, safari and firefox), but Windows machines cannot recognize currency symbols, and it looks like this:

https://prnt.sc/hau1xj

I don't know how and why this happens, but if you have the same problem, you can try to use HTML entities instead of utf8 symbols.

Check out this gist - it contains currency codes mapped to the html entities: https://gist.github.com/Gibbs/3920259#gistcomment-2259740

PEN currency symbol

Hi,

I don't live in Peru, but I think that they changed the currency symbol for PEN from S/. to S/ (no dot).
Please check https://es.wikipedia.org/wiki/Sol_(moneda_del_Perú)

Thank you!

IQD Symbol is incorrect

IQD, the symbol for the Iraqi Dinar Symbol is incorrect.

currently listed in the package: ع.د
actual symbol: د.ع

bower install currency-symbol-map

Are you open to PR's to allow bower installing currency-symbol-map? I'd like to use this package in-browser.

Someone forked this repo a few months back: https://github.com/rhodgkins/currency-symbol-map/tree/bower, though it needs a little cleanup.

SGD Wrong Symbol

Hi @bengourley,
I think SGD symbol is wrong. I've created a PR(#55 ) for this.
Kindly review this & merge it.

Zambian Currency ZMK is missing

Zambian Currency ZMK is missing.
https://www.xe.com/currency/zmk-zambian-kwacha

Canadian sign - CAD

Is there any support for Canadian dollar sign?
We should separate it then USD

Getting undefined when using ES6 import statement in Nestjs.

First of all thank you for the amazing library.

Here is the issue I am getting, the value of getSymbolFromCurrency is undefined when I am importing using ES6 import as follows:

import getSymbolFromCurrency from 'currency-symbol-map';

version:
"currency-symbol-map": "^5.1.0"

Currently I am using the commonjs require method as a workaround.
Please let me know how to fix it.