Lightweight & Fast JavaScript Number Formatter. 

Lightweight & Fast JavaScript Number Formatter

mottie

number-format.js

 * Lightweight & Fast JavaScript Number Formatter

 * @preserve IntegraXor Web SCADA - JavaScript Number Formatter (http://www.integraxor.com/)

 * @link http://mottie.github.com/javascript-number-formatter/

	maskObj.prefix = start > 0 ? mask.substring(0, start) : "";

	// Reverse string: not an ideal method if there are surrogate pairs

	const end = getIndex(mask.split("").reverse().join(""));

	const substr = mask.substring(offset, offset + 1);

	// Add 1 to offset if mask has a trailing decimal/comma

	const indx = offset + ((substr === "." || (substr === ",")) ? 1 : 0);

	maskObj.suffix = end > 0 ? mask.substring(indx, len) : "";

	maskObj.mask = mask.substring(start, indx);

	maskObj.maskHasNegativeSign = maskObj.mask.charAt(0) === "-";

	maskObj.maskHasPositiveSign = maskObj.mask.charAt(0) === "+";

	// Search for group separator & decimal; anything not digit,

	let result = maskObj.mask.match(notMaskRegex);

	// Treat the right most symbol as decimal

	maskObj.decimal = (result && result[result.length - 1]) || ".";

	// Treat the left most symbol as group separator

	maskObj.separator = (result && result[1] && result[0]) || ",";

	// Split the decimal for the format string if any

	result = maskObj.mask.split(maskObj.decimal);

function processValue(value, maskObj, options) {

		// Process only abs(), and turn on flag.

	// Fix the decimal first, toFixed will auto fill trailing zero.

	valObj.value = Number(valObj.value).toFixed(maskObj.fraction && maskObj.fraction.length);

	// Convert number to string to trim off *all* trailing decimal zero(es)

	// Fill back any trailing zero according to format

	const posTrailZero = maskObj.fraction && maskObj.fraction.lastIndexOf("0");

	let [valInteger = "0", valFraction = ""] = valObj.value.split(".");

	if (!valFraction || (valFraction && valFraction.length <= posTrailZero)) {

		valFraction = (Number("0." + valFraction).toFixed(posTrailZero + 1)).replace("0.", "");

	// Remove negative sign if result is zero

	if (valObj.result === "0" || valObj.result === "") {

		// Remove negative sign if result is zero

	if (!isNegative && maskObj.maskHasPositiveSign) {

	} else if (isNegative && maskObj.maskHasPositiveSign) {

		valObj.sign = options && options.enforceMaskSign && !maskObj.maskHasNegativeSign ? "" : "-";

function addSeparators(valObj, maskObj) {

	const szSep = maskObj.integer.split(maskObj.separator);

	// Join back without separator for counting the pos of any leading 0

	const posLeadZero = maskInteger && maskInteger.indexOf("0");

		while (valObj.integer.length < (maskInteger.length - posLeadZero)) {

			valObj.integer = "0" + valObj.integer;

	} else if (Number(valObj.integer) === 0) {

	typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :

	typeof define === 'function' && define.amd ? define(factory) :

		maskObj.prefix = start > 0 ? mask.substring(0, start) : "";

		// Reverse string: not an ideal method if there are surrogate pairs

		const end = getIndex(mask.split("").reverse().join(""));

		const substr = mask.substring(offset, offset + 1);

		// Add 1 to offset if mask has a trailing decimal/comma

		const indx = offset + ((substr === "." || (substr === ",")) ? 1 : 0);

		maskObj.suffix = end > 0 ? mask.substring(indx, len) : "";

		maskObj.mask = mask.substring(start, indx);

		maskObj.maskHasNegativeSign = maskObj.mask.charAt(0) === "-";

		maskObj.maskHasPositiveSign = maskObj.mask.charAt(0) === "+";

		// Search for group separator & decimal; anything not digit,

		let result = maskObj.mask.match(notMaskRegex);

		// Treat the right most symbol as decimal

		maskObj.decimal = (result && result[result.length - 1]) || ".";

		// Treat the left most symbol as group separator

		maskObj.separator = (result && result[1] && result[0]) || ",";

		// Split the decimal for the format string if any

		result = maskObj.mask.split(maskObj.decimal);

	function processValue(value, maskObj, options) {

			// Process only abs(), and turn on flag.

		// Fix the decimal first, toFixed will auto fill trailing zero.

		valObj.value = Number(valObj.value).toFixed(maskObj.fraction && maskObj.fraction.length);

		// Convert number to string to trim off *all* trailing decimal zero(es)

		valObj.value = valObj.value.toString();

		// Fill back any trailing zero according to format

		const posTrailZero = maskObj.fraction && maskObj.fraction.lastIndexOf("0");

		let [valInteger = "0", valFraction = ""] = valObj.value.split(".");

		if (!valFraction || (valFraction && valFraction.length <= posTrailZero)) {

			valFraction = (Number("0." + valFraction).toFixed(posTrailZero + 1)).replace("0.", "");

		if (valObj.result === "0" || valObj.result === "") {

			// Remove negative sign if result is zero

		if (!isNegative && maskObj.maskHasPositiveSign) {

		} else if (isNegative && maskObj.maskHasPositiveSign) {

			valObj.sign = options && options.enforceMaskSign && !maskObj.maskHasNegativeSign ? "" : "-";

	function addSeparators(valObj, maskObj) {

		const szSep = maskObj.integer.split(maskObj.separator);

		// Join back without separator for counting the pos of any leading 0

		const posLeadZero = maskInteger && maskInteger.indexOf("0");

  "description": "Lightweight & Fast JavaScript Number Formatter",

  "homepage": "http://mottie.github.com/javascript-number-formatter/",

  "demo": "https://github.com/Mottie/javascript-number-formatter/index.html",

    "url": "git://github.com/Mottie/javascript-number-formatter.git"

    "url": "https://code.google.com/u/100789773228459308870/"

      "url": "https://github.com/Mottie",

  "bugs": "https://github.com/Mottie/javascript-number-formatter/issues",

  "docs": "http://mottie.github.com/javascript-number-formatter/index.html",

    "updater": "npx updates -cu && npm install"

    "rollup-plugin-node-resolve": "^3.4.0",

[![Build Status][build-image]][build-url] [![NPM Version][npm-image]][npm-url] [![devDependency Status][david-dev-image]][david-dev-url] [![MIT][license-image]][license-url]

This standalone number formatter<sup>&dagger;</sup> is intended to be short and fast. As they are the main factors for a high performance JavaScript app. Development release is as short as < 120 lines including license info, blank lines and comments. And production release is less than 1,200 bytes.

format( "#,##0.####", 1234567.890 );  // output: "1,234,567.89"

format( "$ #,###.00", -1234567.890 ); // output: "$ -1,234,567.89"

format( "$ #,###.00", -1234567.890, {enforceMaskSign: true});  // output: "$ 1,234,567.89"

format( "$ -#,###.00", -1234567.890, {enforceMaskSign: true}); // output: "$ -1,234,567.89"

format( "$ +#,###.00", -1234567.890, {enforceMaskSign: true}); // output: "$ -1,234,567.89"

format( "$ +#,###.00", 1234567.890, {enforceMaskSign: true});  // output: "$ +1,234,567.89"

&dagger; Initial development release of this code was written by KPL and hosted at [Google Code](https://code.google.com/p/javascript-number-formatter/).

* Accept standard number formatting like `#,##0.00` or with negation `-000.####`.

* Accept any country format like `# ##0,00`, `#,###.##`, `#'###.##` or any type of non-numbering symbol.

* Accept any numbers of digit grouping. `#,##,#0.000` or `#,###0.##` are all valid.

* Accept any redundant/fool-proof formatting. `##,###,##.#` or `0#,#00#.###0#` are all OK.

* Simple interface, just supply mask & value like this: `format( "0.0000", 3.141592)`.

* Include a prefix &amp; suffix with the mask.

* <del>No prefix or suffix is allowed except leading negation symbol. So `$#,##0.00` or `#,###.##USD` will not yield expected outcome. Use `'$'+format('#,##0.00', 123.45)` or `format('#,##0.00', 456.789) + 'USD'`</del>

* The prefix or suffix *can not* include any numbers (`0-9`), dashes (`-`), or plus signs (`+`).

When only one symbol is supplied, the library will always treat that symbol as a decimal. For example, `format( '#,###', 1234567.890)` will output `1234567,890`.

To force a single symbol to be used as a separator, add a trailing symbol. In this example, a period is added to the end of the mask - `format( '#,###.', 1234567.890)` - resulting in it being used as a decimal and forcing the first symbol to be the separator and return this output: `1,234,567`.

A demo/sample page with few examples is provided ([demo](http://mottie.github.io/javascript-number-formatter/)).

And a jsFiddle was created to aid in testing: https://jsfiddle.net/Mottie/t2etyodx/

[build-url]: https://travis-ci.org/Mottie/javascript-number-formatter

[build-image]: https://travis-ci.org/Mottie/javascript-number-formatter.png?branch=master

[npm-url]: https://www.npmjs.com/package/number-format.js

[npm-image]: https://img.shields.io/npm/v/number-format.js.svg

[david-dev-url]: https://david-dm.org/Mottie/javascript-number-formatter?type=dev

[david-dev-image]: https://david-dm.org/Mottie/javascript-number-formatter/dev-status.svg

[license-url]: https://github.com/Mottie/javascript-number-formatter/blob/master/LICENSE

[license-image]: https://img.shields.io/badge/license-MIT-blue.svg

View the [complete change log here](https://github.com/Mottie/javascript-number-formatter/wiki).

* Add `ignoreSign` option (modified to `enforeceMaskSign`!).

* Meta: Update dot files & remove bower support.

  * Rename `ignoreSign` to `enforceMaskSign` (default `false`).

  * Switch demo to use lib file & highlight valid results.

  * Different Handling for Negative "-" and Positive "+" Signs. See [pull #11](https://github.com/Mottie/javascript-number-formatter/pull/11); thanks [@hyyan](https://github.com/hyyan)!

  * Prevent JS error when passing a string.

  * Add typescript support. See [pull #8](https://github.com/Mottie/javascript-number-formatter/pull/8); thanks [@chuv](https://github.com/chuv)!

  * Use https. Fixes [issue #13](https://github.com/Mottie/javascript-number-formatter/issues/13).

  * Remove GPL portion of the license &amp; update `package.json` entry.

  * Fix build process to use the updated `package.json` license format.

		@@ -11,3 +11,3 @@ /**
		* @link http://mottie.github.com/javascript-number-formatter/
		* @version 2.0.4
		* @version 2.0.5
		*/
		@@ -14,0 +14,0 @@ const maskRegex = /[0-9\-+#]/;

		@@ -11,3 +11,3 @@ /**
		* @link http://mottie.github.com/javascript-number-formatter/
		* @version 2.0.4
		* @version 2.0.5
		*/
		@@ -14,0 +14,0 @@ (function (global, factory) {

		@@ -5,3 +5,3 @@ {
		"description": "Lightweight & Fast JavaScript Number Formatter",
		"version": "2.0.4",
		"version": "2.0.5",
		"homepage": "http://mottie.github.com/javascript-number-formatter/",
		@@ -8,0 +8,0 @@ "main": "lib/format.min.js",

		@@ -74,3 +74,3 @@ # Javascript Number Formatter

		### v2.0.0 – 2.0.4 (2018-10-26)
		### v2.0.0 – 2.0.5 (2018-10-26)

		@@ -77,0 +77,0 @@ * Add `ignoreSign` option (modified to `enforeceMaskSign`!).