string-remove-thousand-separators^5.0.16

Detects and removes thousand separators (dot/comma/quote/space) from string-type digits

Install via npm

npm i string-remove-thousand-separators

Consume via a require():

const { remSep } = require("string-remove-thousand-separators");

or as an ES Module:

import { remSep } from "string-remove-thousand-separators";

Install as a script, via CDN

Put this in your HTML:

<script src="https://cdn.jsdelivr.net/npm/string-remove-thousand-separators/dist/string-remove-thousand-separators.umd.js"></script>

Then, you’ll get a global variable stringRemoveThousandSeparators in your Global object and you consume it like this:

const { remSep } = stringRemoveThousandSeparators;

Trivia

This program has 84 assertions in its unit tests. That's more than all unit test assertions' median (44) and more than geometric mean (72).

In monorepo, one other package, csv-split-easy, consumes this package.

§ Quick Take

import { strict as assert } from "assert";
import { remSep } from "string-remove-thousand-separators";

// 🇬🇧 🇺🇸 thousand separators:
assert.equal(remSep("1,000,000.00"), "1000000.00");

// 🇷🇺  thousand separators:
assert.equal(remSep("1 000 000,00"), "1000000,00");
// (if you want it converted to Western notation with dot,
// set opts.forceUKStyle = true

// 🇨🇭 thousand separators:
assert.equal(remSep("1'000'000.00"), "1000000.00");

// IT'S SMART TOO:

// will not delete if the thousand separators are mixed:
const input = "100,000,000.000";
assert.equal(remSep(input), input);
// ^ does nothing

// but will remove empty space, even if there is no decimal separator:
// (that's to cope with Russian notation integers that use thousand separators)
assert.equal(
  remSep("100 000 000 000"),
  "100000000000"
);

// while removing thousand separators, it will also pad the digits to two decimal places
// (optional, on by default, to turn it off set opts.padSingleDecimalPlaceNumbers to `false`):
assert.equal(remSep("100,000.2"), "100000.20");
console.log();
// ^ Western notation

assert.equal(remSep("100 000,2"), "100000,20");
// ^ Russian notation

assert.equal(remSep("100'000.2"), "100000.20");
// ^ Swiss notation

⬆ back to top

§ API

remSep(str, [opts])

If first argument (input) is not string, it will throw and error. Second input argument, opts, is optional. However, if it is present and is not null, not undefined and not a plain object, it will throw and error.

⬆ back to top

§ options

Defaults:

    {
      removeThousandSeparatorsFromNumbers: true,
      padSingleDecimalPlaceNumbers: true,
      forceUKStyle: false
    }

`options` object's key	Type	Obligatory?	Default	Description
`removeThousandSeparatorsFromNumbers`	Boolean	no	`true`	Should remove thousand separators? `1,000,000` → `1000000`? Or Swiss-style, `1'000'000` → `1000000`? Or Russian-style, `1 000 000` → `1000000`?
`padSingleDecimalPlaceNumbers`	Boolean	no	`true`	Should we pad one decimal place numbers with zero? `100.2` → `100.20`?
`forceUKStyle`	Boolean	no	`false`	Should we convert the decimal separator commas into dots? `1,5` → `1.5`?