Socket
Socket
Sign inDemoInstall

num-format

Package Overview
Dependencies
1
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

num-format

Pretty Printer for Currency, Percentages, Numbers


Version published
Weekly downloads
31
decreased by-29.55%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

num-format · GitHub license Version 0.1.0 Coverage Status CI Status PRs Welcome

Number pretty printer for currency, percents, and adding thousands separators.

FormatCurrency

Parameters

  • number: Number - Value to convert
  • roundToInteger: Boolean - Defaults to true (Optional)
  • locale: String - Defaults to 'en-US' (Optional)
  • currency: String - Defaults to 'USD' (Optional)

Examples

  // Pretty Print: Currency (w/ Cents - Trailing 0s)
>> FormatCurrency(123456, false); // '$123,456.00'

  // Pretty Print: Currency (w/ Cents)
>> FormatCurrency(123456.78, false); // '$123,456.78'


  // Pretty Print: Currency (Rounded)
>> FormatCurrency(9876.54); // '$9,877'


  // Pretty Print: Currency (Locale Override - United Kingdom - Integer)
>> FormatCurrency(123456.78, true, 'en-GB', 'GBP'); // '£123,457'

FormatNumber

Parameters

  • number: Number - Value to convert
  • precision: Number - Defaults to 2 (Optional)
  • locale: String - Defaults to 'en-US' (Optional)

Examples

  // Pretty Print: Number  (2 places)'
>> FormatNumber(1000); // '1,000'


  // Pretty Print: Number  (1 place)'
>> FormatNumber(1234567.89, 1); // '1,234,567.9'


  // Pretty Print: Number  (0 places - Round)'
>> FormatNumber(22333.44, 0); // '22,333'

FormatPercent

Parameters

  • number: Number - Value to convert
  • precision: Number - Defaults to 2 (Optional)
  • locale: String - Defaults to 'en-US' (Optional)

Examples

  // Pretty Print: Percentage (2 places)'
>> FormatPercent(0.8522); // '85.22%'


  // Pretty Print: Percentage (Trailing 0)'
>> FormatPercent(0.135); // '13.50%'


  // Pretty Print: Percentage (1 place)'
>> FormatPercent(0.7337, 1); // '73.4%'


  // Pretty Print: Percentage (0 places - Round Up)'
>> FormatPercent(0.5567, 0); // '56%'


  // Pretty Print: Percentage (0 places - Round Down)
>> FormatPercent(0.3312, 0); // '33%'

Locale Support:

In the current version of num-format it should be assumed that only en-US formatting is supported as Node 8.x has limited locale support.


Keywords

FAQs

Package last updated on 17 Oct 2019

Did you know?

Socket

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

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc