selective-whitespace

Condense all whitespace in a string, with options to preserve specific whitespace characters.

Install

$ npm install --save selective-whitespace

Usage

1var selectiveWhitespace = require('selective-whitespace');
2
3// Condense all whitespace (including \t\n\r)
4selectiveWhitespace('  FOO      BAR    BAZ ');
5//=> 'FOO BAR BAZ'
6
7// Condense all whitespace (keep newlines)
8selectiveWhitespace('FOO\n   BAR\n   BAZ\n ', {keep: '\n'});
9//=> 'FOO\n BAR\n BAZ\n'
10
11// Condense all whitespace (keep tabs)
12selectiveWhitespace('\tFOO     \tBAR      \tBAZ', {keep: '\t'});
13//=> '\tFOO \tBAR \tBAZ'
14
15// Condense all whitespace (keep tabs and newlines)
16selectiveWhitespace('\n\tFOO     \n\tBAR      \n\tBAZ', {keep: '\t,\n'});
17//=> '\n\tFOO \n\tBAR \n\tBAZ'
18
19// Strip all whitespace characters
20selectiveWhitespace('\t\nFOO     \t\nBAR      \t\nBAZ', {stripAll:true});
21//=> 'FOOBARBAZ'

API

selectiveWhitespace(str, [options]);

str

Required
Type: string

The string you want to condense.

options

Type: object

Set or override the default options.

keep

Type: string
options: \n\t\r

Comma or pipe-delimited list of values to preserve. You can preserve newlines \n, tabs \t or return characters \r.

stripAll

Type: Boolean
Default: false

stripAll mode will remove all whitespace characters from the string.

License

MIT © Michael Wuergler