Awesome

collapse-white-space

Collapse white space.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • collapseWhiteSpace(value[, options|style])
• Types
• Compatibility
• Security
• Related
• Contribute
• License

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 14.14+, 16.0+), install with npm:

npm install collapse-white-space

In Deno with esm.sh:

import {collapseWhiteSpace} from 'https://esm.sh/collapse-white-space@2'

In browsers with esm.sh:

<script type="module">
  import {collapseWhiteSpace} from 'https://esm.sh/collapse-white-space@2?bundle'
</script>

Use

import {collapseWhiteSpace} from 'collapse-white-space'

collapseWhiteSpace('\tfoo \n\tbar  \t\r\nbaz') //=> ' foo bar baz'

API

This package exports the identifier collapseWhiteSpace. There is no default export.

collapseWhiteSpace(value[, options|style])

Collapse white space in value (string).

style

Treated as options.style ('html' or 'js', default: 'js').

options

Configuration (optional).

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

Value with collapsed white space (string).

Types

This package is fully typed with TypeScript. It exports the additional types Options and Style.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.

Security

This package is safe.

Related

• wooorm/is-whitespace-character — check if a character is a white space character
• wooorm/detab — convert tabs to spaces
• wooorm/trim-lines — remove tabs and spaces around line-breaks

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer