string-remove-thousand-separators4.0.3

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

Β§ 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

Β§ 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.

Β§ options

Defaults:

    {
removeThousandSeparatorsFromNumbers: true,
padSingleDecimalPlaceNumbers: true,
forceUKStyle: false
}
options object's keyTypeObligatory?DefaultDescription
removeThousandSeparatorsFromNumbersBooleannotrueShould remove thousand separators? 1,000,000 β†’ 1000000? Or Swiss-style, 1'000'000 β†’ 1000000? Or Russian-style, 1 000 000 β†’ 1000000?
padSingleDecimalPlaceNumbersBooleannotrueShould we pad one decimal place numbers with zero? 100.2 β†’ 100.20?
forceUKStyleBooleannofalseShould we convert the decimal separator commas into dots? 1,5 β†’ 1.5?

Β§ Changelog

See it in the monorepo opens in a new tab, on Sourcehut.

Β§ Licence

MIT opens in a new tab

Copyright Β© 2010–2020 Roy Revelt and other contributors

Related packages:

πŸ“¦ detergent 6.1.1
Extracts, cleans and encodes text
πŸ“¦ csv-split-easy 4.0.3
Splits the CSV string into array of arrays, each representing a row of columns
πŸ“¦ string-find-malformed 1.2.1
Search for a malformed string. Think of Levenshtein distance but in search
πŸ“¦ string-unfancy 3.10.1
Replace all n/m dashes, curly quotes with their simpler equivalents
πŸ“¦ string-strip-html 7.0.3
Strips HTML tags from strings. No parser, accepts mixed sources
πŸ“¦ string-collapse-white-space 8.0.5
Replace chunks of whitespace with a single spaces
πŸ“¦ string-range-expander 1.12.0
Expands string index ranges within whitespace boundaries until letters are met