collapse-white-space

What is collapse-white-space?

The collapse-white-space npm package is designed to reduce multiple whitespace characters in a string down to a single space, effectively 'collapsing' them. This can be particularly useful for cleaning up strings in web development contexts, such as user input or text content processing, where consistent whitespace handling is desired.

What are collapse-white-space's main functionalities?

Collapsing multiple whitespace characters

This feature allows you to take a string with multiple spaces, tabs, or other whitespace characters and reduce them to a single space between words or characters. It's particularly useful for text normalization.

"use strict";\nconst collapse = require('collapse-white-space');\nconst text = 'This    is  a    test string.';\nconsole.log(collapse(text)); // 'This is a test string.'

Other packages similar to collapse-white-space

trim

The trim package offers functionality to remove leading and trailing whitespace from a string. While it doesn't collapse internal whitespace, it's often used in conjunction with other methods to clean up strings. It's more focused compared to collapse-white-space, which handles internal whitespace collapsing.

README

collapse-white-space

Replace multiple white-space characters with a single space.

Installation

npm:

npm install collapse-white-space

Usage

Dependencies.

var collapse = require('collapse-white-space');

Collapse white space:

var result = collapse('\tfoo \n\tbar  \t\r\nbaz');

Yields:

 foo bar baz

API

collapse(value)

Replace multiple white-space characters with a single space.

Parameters

• value (string) — Value with uncollapsed white-space, coerced to string.

Returns

string — Value with collapsed white-space.

commaSeparated.stringify(values[, options])

Compile an array of strings to comma-separated tokens. Handles empty items at start or end correctly. Note that it’s not possible to specify initial or final white-space per value.

Parameters

• values (Array.<string>) — List of tokens;

• options (Object, optional):

  • padLeft (boolean, default: true) — Whether to pad a space before a token;
  • padRight (boolean, default: false) — Whether to pad a space after a token.

Returns

string — Comma-separated tokens.

License

MIT © Titus Wormer