Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

currency-symbol

atomicman5722.6kMIT1.0.6

A simple lightweight package that returns a country currency numeric symbol and also list all countries currency

currency, symbol, Currency, Countries, Country, Dollar, Naira, World, Nodejs, Node, Symbol, Currencies, Numeric, Nigeria, Ghana, Naija, USA, USD, Cedis, NGN, GHC

readme

currency-symbol

NPM

npm version

A simple lightweight zero dependency package that returns a country currency numeric symbol and can also list all countries currency.

Installation


npm install currency-symbol

Example

//ES5
const currencySymbol = require('currency-symbol');

// ES6
import currencySymbol from 'currency-symbol';

console.log(currencySymbol.all());
// This will return all curriencies symbol

console.log(currencySymbol.symbol("United States")); //$
// This will return '$' which is $.

console.log(currencySymbol.symbol("USD")); //$
// This will return '$' which is $.

console.log(currencySymbol.symbol("Dollar")); //$
// This will return '$' which is $.

console.log(currencySymbol.symbol("Nigeria")); //₦
// This will return '₦' which is ₦.

console.log(currencySymbol.symbol("NGN")); //₦
// This will return '₦' which is ₦.

console.log(currencySymbol.symbol("Naira")); //₦
// This will return '₦' which is ₦.

console.log(currencySymbol.symbol("GHC")); //¢
// This will return '¢' which is ¢

console.log(currencySymbol.symbol("Ghana")); //¢
// This will also return '¢' which is ¢

console.log(currencySymbol.symbol("Cedis")); //¢
// This will also return '¢' which is ¢.

/***
* Note: the .symbol() function takes any of this arguments - Country Name, Currency Name and Currency Abbreviation and return the currency symbol.
***/

Note

  • When you render the numeric symbol in html it will display the symbol i.e when you render '&#162' it will display ¢.

Functions

| function | argument | response | | | |-------------|-----------------------------------------------------|-----------------------------------------------------|---|---| | .all() | none | it returns all currency symbol | | | | .symbol(name) | name(Country Name or Currency Name or Currency Abbreviation) | it returns a symbol for a particular country or currency .

Features

  • It lists all symbols for all curriencies in the world.
  • it returns symbol for a particular country/currency.
  • It is lightweight and has zero dependency.

Contributing

  • Fork this repositry to your account.
  • Clone your repositry: git clone git@github.com:your-username/currency-symbol.git
  • Create your feature branch: git checkout -b feature/feature-id/<3-4 word feature description>
  • Commit your changes: git commit -m "feature(scope): (subject) <BLANK LINE> (body) <BLANK LINE> (footer)"
  • Push to the remote branch: git push origin new-feature

  • Open a pull request.

  • Commit Message Convention

    • scope should be something specific to the commit change e.g logo
    • subject text should:
      • use present tense: "save" not "saved" or "saving"
      • not capitalize first letter i.e no "Carry to safety"
      • not end with a dot (.)

    • Message body (optional) If a body is to be written, it should:

      • written in present tense.
      • include reason for change and difference in the previous behaviour

    • Message Footer This should be used for referencing the issues using the following keywords: Start, Delivers, Fixes and Finishes. It should be written as:

      • [Start #345]

License

This project is authored by Philips Blessing and is licensed for your use, modification and distribution under the MIT license.