Socket
Socket
Sign inDemoInstall

simple-currency-format

Package Overview
Dependencies
0
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    simple-currency-format

Format currency when Intl is not available


Version published
Weekly downloads
5.1K
decreased by-6.1%
Maintainers
1
Install size
727 kB
Created
Weekly downloads
 

Readme

Source

Simple Currency formatter

A simple, lightweight, localized currency formatter.

IF you do not have access to Javascript Intl library.
Like when you are running on Android with React Native.
Then your can use this simplified formatter.

It is simplified in a way that it will always return the same currency symbols for any given currency code.
Even when a locale that should render a specific other symbol is used.
This library simply use the symbol that is used in the prefered currency in a locale.

Install

npm install simple-currency-format
yarn add simple-currency-format

Documentation

currencyFormat(amount, locale, currency, decimals)

Parameters:

amount: number, The number to format

locale: string, The locale for the format (i.e. de-DE, en-US,en-GB )

currency: string, Currency code (i.e. EUR, USD, GBP)

decimals: number, Number of decimals (default: 0)

Returns: string, Formatted currency

Example:
import { currencyFormat } from 'simple-currency-format';
console.log(currencyFormat(1000000, 'sv-SE', 'SEK'));
// 1 000 000 kr
console.log(currencyFormat(1000000, 'en-GB', 'GBP'));
// £1,000,000
console.log(currencyFormat(1000000, 'mt-MT', 'EUR'));
// €1,000,000
console.log(currencyFormat(1000000, 'de-DE', 'EUR'));
// 1.000.000 €
console.log(currencyFormat(1000000, 'en-US', 'USD'));
// $1, 000, 000;

getCurrencySymbol(currency)

Parameters:

currency: string, Currency code (i.e. EUR, USD, GBP)

Returns: string, Currency symbol (i.e. kr, £)

Example:
import { getCurrencySymbol } from 'simple-currency-format';
console.log(getCurrencySymbol('SEK'));
// kr;
console.log(getCurrencySymbol('GBP'));
// £;

Credits

  • Intl.js: We use currency format data from this library.
  • currency-symbol-map: We use currency symbol mapping from this library.

FAQs

Last updated on 09 Apr 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc