currency-library

1.0.1 • Public • Published

currency-library

build coverage version license size

Easily get data about different currencies in Javascript

Usage

getAll

getByIsoCode

getByNumericCode

getBySymbol

getAll

Parameters

None

Return value

Returns object with ISO currency code as a key

const currencyLibrary = require('currency-library');
// OR
import * as currencyLibrary from 'currency-library';

console.log(currencyLibrary.getAll());
/** =>
 {
  //...
  USD: {
    isoCode: 'USD',
    numericCode: '840',
    minorUnits: 2,
    name: 'United States dollar',
    symbol: '$'
  },
  UAH: {
    isoCode: 'UAH',
    numericCode: '980',
    minorUnits: 2,
    name: 'Ukrainian hryvnia',
    symbol: '₴'
  },
  // ...
}
 **/

getByIsoCode

Parameters

Expects ISO code string as only parameter

Return value

Returns currency object or undefined if currency not found

const currencyLibrary = require('currency-library');
// OR
import * as currencyLibrary from 'currency-library';

console.log(currencyLibrary.getByIsoCode('UAH'));
/** =>
 {
  isoCode: 'UAH',
  numericCode: '980',
  minorUnits: 2,
  name: 'Ukrainian hryvnia',
  symbol: '₴'
}
 **/
console.log(currencyLibrary.getByIsoCode('WRONG CODE'));
// => undefined

getByNumericCode

Parameters

Expects numeric currency code as only parameter

Return value

Returns currency object or undefined if currency not found

const currencyLibrary = require('currency-library');
// OR
import * as currencyLibrary from 'currency-library';

console.log(currencyLibrary.getByNumericCode(980));
/** =>
 {
  isoCode: 'UAH',
  numericCode: '980',
  minorUnits: 2,
  name: 'Ukrainian hryvnia',
  symbol: '₴'
}
 **/
console.log(currencyLibrary.getByNumericCode(-1));
// => undefined

getBySymbol

Parameters

Expects symbol parameter as only parameter

Return value

Returns currency object or undefined if currency not found

const currencyLibrary = require('currency-library');
// OR
import * as currencyLibrary from 'currency-library';

console.log(currencyLibrary.getBySymbol('₴'));
/** =>
 {
  isoCode: 'UAH',
  numericCode: '980',
  minorUnits: 2,
  name: 'Ukrainian hryvnia',
  symbol: '₴'
}
 **/
console.log(currencyLibrary.getBySymbol('~'));
// => undefined

Development

Run tests:

npm test -- --coverage

Package Sidebar

Install

npm i currency-library

Weekly Downloads

200

Version

1.0.1

License

MIT

Unpacked Size

26.4 kB

Total Files

9

Last publish

Collaborators

  • harmoxyne