numeral

What is numeral?

The numeral npm package is a library for formatting and manipulating numbers. It allows users to perform number formatting, including currency, percentages, and time; convert between different units; and manipulate numbers with mathematical operations.

What are numeral's main functionalities?

Number Formatting

This feature allows users to format numbers with commas as thousands separators, which is useful for displaying large numbers in a more readable format.

"const numeral = require('numeral');\nlet number = numeral(1000);\nlet formatted = number.format('0,0');\nconsole.log(formatted); // '1,000'"

Currency Formatting

Currency formatting feature enables users to format numbers as currency, including the addition of currency symbols and control over decimal places, making it easier to display monetary values.

"const numeral = require('numeral');\nlet money = numeral(1000.234);\nlet formatted = money.format('$0,0.00');\nconsole.log(formatted); // '$1,000.23'"

Percentage Formatting

This feature allows for the formatting of numbers as percentages, including rounding and specifying the number of decimal places, useful for displaying ratios or proportions.

"const numeral = require('numeral');\nlet percent = numeral(0.974878234);\nlet formatted = percent.format('0.00%');\nconsole.log(formatted); // '97.49%'"

Other packages similar to numeral

accounting

The accounting package provides number, money and currency formatting. It is similar to numeral in terms of its capabilities for formatting currencies and numbers, but it does not offer the same level of support for percentages or non-monetary number formatting.

numbro

Numbro is a fork of numeral.js focused on being a reliable library for number formatting and manipulation. It offers similar functionalities to numeral, including number, currency, and percentage formatting, but with additional localization options and a slightly different API.

README

Numeral.js

A javascript library for formatting and manipulating numbers.

Website and documentation

Changelog

1.4.0

Add optional format for all decimals

1.3.4

Remove AMD module id. (This is encouraged by require.js to make the module more portable, and keep it from creating a global)

1.3.3

AMD define() compatibility.

1.3.2

Bug fix: Formatting some numbers results in the wrong value. Issue #21

1.3.1

Bug fix: Minor fix to unformatting parser

1.3.0

Add support for spaces before/after $, a, o, b in a format string

Bug fix: Fix unformat for languages that use '.' in ordinals

Bug fix: Fix round up floating numbers with no precision correctly.

Bug fix: Fix currency signs at the end in unformat

1.2.6

Add support for optional decimal places

1.2.5

Add support for appending currency symbol

1.2.4

Add support for humanized filesizes

1.2.3

Bug Fix: Fix unformatting for languages that use '.' as thousands delimiter

1.2.2

Changed language definition property 'money' to 'currency'

1.2.1

Bug fix: Fix unformatting non-negative abbreviations

1.2.0

Add language support

Update testing for to include languages

1.1.0

Add Tests

Bug fix: Fix difference returning negative values

1.0.4

Bug fix: Non negative numbers were displaying as negative when using parentheses

1.0.3

Add ordinal formatting using 'o' in the format

1.0.2

Add clone functionality

1.0.1

Added abbreviations for thousands and millions using 'a' in the format

1.0.0

Initial release

Acknowlegements

Numeral.js, while less complex, was inspired by and heavily borrowed from Moment.js

License

Numeral.js is freely distributable under the terms of the MIT license.

Copyright (c) 2012 Adam Draper

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.