currency-symbol-map - npm Package Compare versions

Comparing version 2.2.0 to 3.0.0

currency-symbol-map.js

@@ -1,11 +0,38 @@
-module.exports = mapSymbol
+var currencySymbolMap = require('./map');
 
-var map = require('./map')
+var symbolCurrencyMap = {};
+for (var key in currencySymbolMap) {
+  if (currencySymbolMap.hasOwnProperty(key)) {
+    var currency = key;
+    var symbol = currencySymbolMap[currency];
+    symbolCurrencyMap[symbol] = currency;
+  }
+}
 
-function mapSymbol(currencyCode) {
-  if (map.hasOwnProperty(currencyCode)) {
-    return map[currencyCode]
+function getSymbolFromCurrency(currencyCode) {
+  if (currencySymbolMap.hasOwnProperty(currencyCode)) {
+    return currencySymbolMap[currencyCode];
   } else {
-    return '?'
+    return undefined;
   }
-}
+}
+
+function getCurrencyFromSymbol(symbol) {
+  if (symbolCurrencyMap.hasOwnProperty(symbol)) {
+    return symbolCurrencyMap[symbol];
+  } else {
+    return undefined;
+  }
+}
+
+function getSymbol(currencyCode) {
+  //Deprecated
+  var symbol = getSymbolFromCurrency(currencyCode);
+  return symbol !== undefined ? symbol : '?';
+}
+
+module.exports = getSymbol; //Backward compatibility
+module.exports.getSymbolFromCurrency = getSymbolFromCurrency;
+module.exports.getCurrencyFromSymbol = getCurrencyFromSymbol;
+module.exports.symbolCurrencyMap = symbolCurrencyMap;
+module.exports.currencySymbolMap = currencySymbolMap;

map.js

@@ -38,3 +38,3 @@ module.exports =
 , "FJD": "$"
-, "GHC": "¢"
+, "GHC": "₵"
 , "GIP": "£"
@@ -41,0 +41,0 @@ , "GTQ": "Q"

package.json

 {
   "name": "currency-symbol-map",
-  "version": "2.2.0",
+  "version": "3.0.0",
   "description": "A function to lookup the currency symbol for a given currency code",
   "main": "currency-symbol-map.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "./node_modules/mocha/bin/mocha test.js"
   },
@@ -24,3 +24,6 @@ "publishConfig": {
     "url": "https://github.com/bengourley/currency-symbol-map/issues"
+  },
+  "devDependencies": {
+    "mocha": "^2.4.5"
   }
 }

Readme.md

 # currency-symbol-map
 
-A function to lookup the currency symbol for a given currency code
+A function to lookup the currency symbol for a given currency code and vice versa.
 
@@ -11,3 +11,45 @@ ## Installation
 
+### Get symbol from currency code
 ```js
+var getSymbolFromCurrency = require('currency-symbol-map').getSymbolFromCurrency;
+getSymbolFromCurrency('GBP'); //=> '£'
+getSymbolFromCurrency('EUR'); //=> '€'
+getSymbolFromCurrency('USD'); //=> '$'
+getSymbolFromCurrency('NOT A VALID CODE'); //=> undefined
+```
+
+### Get currency code from symbol
+```js
+var getCurrencyFromSymbol = require('currency-symbol-map').getCurrencyFromSymbol;
+getCurrencyFromSymbol('£'); //=> 'GBP'
+getCurrencyFromSymbol('€'); //=> 'EUR'
+getCurrencyFromSymbol('$'); //=> 'USD'
+getCurrencyFromSymbol('NOT A VALID CODE'); //=> undefined
+```
+
+### Exposed maps for other processing
+```js
+var symbolCurrencyMap = require('currency-symbol-map').symbolCurrencyMap;
+/*
+{
+  "$": "USD",
+  "£": "GBP",
+  ...
+}
+*/
+
+var currencySymbolMap = require('currency-symbol-map').currencySymbolMap;
+/*
+{
+  "USD": "$",
+  "GBP": "£",
+  ...
+}
+*/
+```
+
+## Deprecated usage
+Old usage still works, but could be removed in future versions.
+
+```js
 var getSymbol = require('currency-symbol-map')
@@ -20,2 +62,7 @@ getSymbol('GBP') //=> '£'
 
+## Tests
+```bash
+npm test
+```
+
 ## Credits
@@ -22,0 +69,0 @@

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8670

increased by185.29%

Number of package files

6

increased by50%

Lines of code

225

increased by78.57%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

70

increased by204.35%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

1

increased byInfinity%

No dependency changes