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.
collapse-white-space
Collapse white space.
Contents
What is this?
This is a small package that collapses multiple white space characters into one.
When should I use this?
You can use this package if you want to HTML or JavaScript (default) white space
to a single character.
You can optionally drop initial and final white space.
By default it collapses to a single space, but optionally line endings can be
preserved.
Install
This package is ESM only.
In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install collapse-white-space
In Deno with Skypack:
import {collapseWhiteSpace} from 'https://cdn.skypack.dev/collapse-white-space@2?dts'
In browsers with Skypack:
<script type="module">
import {collapseWhiteSpace} from 'https://cdn.skypack.dev/collapse-white-space@2?min'
</script>
Use
import {collapseWhiteSpace} from 'collapse-white-space'
collapseWhiteSpace('\tfoo \n\tbar \t\r\nbaz')
API
This package exports the following identifier: collapseWhiteSpace
.
There is no default export.
collapseWhiteSpace(value[, options|style])
Collapse white space in value
(string
).
style
Treated as options.style
.
options
Configuration.
options.style
Style of white space to support ('html'
or 'js'
, default: 'js'
).
JavaScript white space matches the pattern \s+
.
HTML white space matches [\t\n\v\f\r ]
.
options.preserveLineEndings
Whether to collapse white space containing a line ending to that line ending
(boolean
, default: false
).
The default is to collapse to a single space.
Line endings matches the pattern \r?\n|\r
.
options.trim
Whether to drop white space at the start and end of value
(boolean
, default:
false
).
The default is to keep it.
Returns
string
– value with collapsed white space.
Types
This package is fully typed with TypeScript.
It exports Options
and Style
types, which specify the interface of the
accepted options.
Compatibility
This package is at least compatible with all maintained versions of Node.js.
As of now, that is Node.js 12.20+, 14.14+, and 16.0+.
It also works in Deno and modern browsers.
Security
This package is safe.
Related
Contribute
Yes please!
See How to Contribute to Open Source.
License
MIT © Titus Wormer