string-collapse-white-space^11.2.6

No 3rd party dependencies. All dependencies and devDependencies, checked recursively, are Codsen packages.

Permalink to InstallationInstallation

Permalink to Quick TakeQuick Take

Permalink to ExamplesExamples

• Minify a chunk of CSS selector
• Collapse a run containing tabs
• Replace tabs inside whitespace runs with ordinary spaces
• Keep at most one consecutive empty line
• Collapse but preserve one leading space
• Preserve one space around each line's content
• Collapse but preserve one trailing space
• Remove empty lines from multiline text
• Inspect the ranges used to produce the collapsed result
• Trim whitespace from the start and end of every line
• Trim multiline content whose boundaries contain non-breaking spaces
• Trim raw non-breaking spaces with ordinary whitespace

API — collapse()

The main function collapse() is imported like this:

Collapse consecutive ASCII spaces and optionally trim or normalize other whitespace. Line breaks remain unless the trimming or empty-line options remove them.

The Optional Options Object has the following shape:

Trimming and empty-line removal take precedence over enforceSpacesOnly: a whitespace segment that is removed does not leave a replacement space. With trimnbsp: false, trimming still removes ordinary whitespace outside a protected non-breaking space. A non-breaking space on one line does not prevent trimming another line.

trimStart: false and trimEnd: false disable whole-string trimming. trimLines: true still trims the first and last lines. By default, ordinary space runs collapse, while other whitespace is preserved unless an enabled option changes it.

removeEmptyLines treats non-breaking-space-only lines as blank even when trimnbsp is false. Keep removeEmptyLines: false when those lines must remain.

collapse() uses the same options and callback contract in ESM and the direct-browser script.

\u00a0 below represents a non-breaking space:

collapse(" \u00a0a").result;
// => "\u00a0a"

collapse("a\t\nb", {
  trimLines: true,
  enforceSpacesOnly: true,
}).result;
// => "a\nb"

Here are all defaults in one place for copying:

Function will return a plain object (Res type above):

It has the following keys:

API — defaults

You can import defaults:

It's a plain object:

The main function calculates the options to be used by merging the options you passed with these defaults.

API — version

You can import version:

opts.cb

The callback receives each proposed edit before it is applied. Return suggested to accept it, another range to customize it, or null to preserve that part of the input. The default callback is ({ suggested }) => suggested.

See examples.

When a whitespace run needs no edit, the callback receives suggested: null. It can still return a range to delete or replace that whitespace. Handle this nullable value before indexing suggested. A run that already produced an edit suggestion does not receive an additional null notification, even when the callback rejects that edit.

A run spanning several lines can produce multiple subrange suggestions. Each reports the boundaries of the complete whitespace run, while suggested identifies the particular edit. All indices refer to the original input, and end indices are exclusive. At the end of the input, whiteSpaceEndsAt equals str.length, including any trailing line breaks, tabs, and non-breaking spaces.

The callback receives one plain object:

API — cbSchema

The list of opts.cb callback object’s key names, as an array of strings:

import { cbSchema } from "string-collapse-white-space";

console.log(cbSchema);
// => ["suggested", "whiteSpaceStartsAt", "whiteSpaceEndsAt", "str"]

It’s exported so that programs wrapping this one — and the unit tests — can assert that a callback object carries exactly these keys, without hardcoding the list in two places.

API — types

This package is written in TypeScript and exports the following types:

import type { Callback, CbObj, Extras, Opts, Range, RangesType, Res } from "string-collapse-white-space";

Permalink to changelogChangelog