parse-decimal-number
Advanced tools
Readme
Parse a decimal number with i18n format support (localized decimal points and thousands separators)
OK, let’s fix international numbers parsing and validation once and forever. I got the inspiration for this in a UI project because somehow the libraries we used didn’t do a great job, so I wrote my own parser, and this is a more polished version of it.
These are the design goals:
NaN for non-numbers. (=good for input validation) ✓In it’s simplest form, you just use it as a parseFloat replacement.
npm i parse-decimal-number --save
parseDecimalNumber = require('parse-decimal-number');
console.log(parseDecimalNumber('12,345,678.90'));
// -> 12345678.90
console.log(parseDecimalNumber('12.345.678,90','.,'));
// -> 12345678.90
Returns a float representation of string or NaN if string is not a parseable number. Use the optional options parameter to specify the thousands and decimal point characters.
string A String that is supposed to contain a number.
options optional A string, array or hash with thousands and decimal separators.
String
a two-character string consisting of the thousands character followed by the decimal point character, e.g. ',.'
Array
An array of two elements, the first being the thousands character, the second being the decimal point character, e.g. ['.',',']
Hash with the following elements (this is compatible with NumeralJS)
thousands thousands separator character. Default: ,decimal decimal point character. Default: .console.log(parseDecimalNumber('12.345.678,90'));
// -> 12345678.90
optionsconsole.log(parseDecimalNumber('12.345.678,90','.,'));
// -> 12345678.90
optionsconsole.log(parseDecimalNumber('12.345.678,90',['.',',']));
// -> 12345678.90
optionsvar customSeparators = {thousands:'.',decimal:','};
console.log(parseDecimalNumber('12.345.678,90',customSeparators));
// -> 12345678.90
Set the default thousands and decimal characters that are used when no options are passed to parseDecimalNumber.
var defaultSeparators = {thousands:'.',decimal:','};
parseDecimalNumber.setOptions(defaultSeparators);
console.log(parseDecimalNumber('12.345.678,90'));
// -> 12345678.90
has the same effect as parseDecimalNumber.setOptions({thousands:',',decimal:'.'};)
Numeral.js is good at formatting numbers and comes with an extensive set of locale data that you can use with parse-decimal-number.
If you use numeral in your project, you can use their locale data as follows:
parseDecimalNumber('12.345.678,90', numeral.countryData('de').delimiters);
// -> 12345678.9
You can of course use the same data to set the default values for parse-decimal-number:
parseDecimalNumber.setOptions(numeral.countryData('de').delimiters);
parseDecimalNumber('12.345.678,90');
// -> 12345678.9
Done :relaxed:
To keep this project as small and modular as possible, the locale data itself has been left out of this library. If you need locale date, other projects might be helpful:
{%= include("tests") %}
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality, and please re-build the documentation with gulp-verb before submitting a pull request.
Andreas Pizsa (http://github.com/AndreasPizsa)
Copyright (c) 2016 Andreas Pizsa (http://github.com/AndreasPizsa), contributors.
This file was generated by gulp-verb on February 10, 2016.
FAQs
Parse a decimal number with i18n format support (localized decimal points and thousands separators)
We found that parse-decimal-number demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
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.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.