string-collapse-white-space^11.2.1

Installation

Quick Take

Examples

• 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:

It’s a function which takes two input arguments:

The Optional Options Object has the following shape:

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

This program implements a callback interface — every reported range is fed to the callback. The default callback is ({ suggested }) => suggested but you can tweak it.

See examples.

When nothing is to be removed, callback will ping suggested key value as null. You can still return any string index range and it will be deleted (array of two elements) or replaced (array of three elements). Learn more about ranges notation.

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";

Changelog