collapse-white-space
    TypeScript icon, indicating that this package has built-in type declarations

    2.1.0 • Public • Published

    collapse-white-space

    Build Coverage Downloads Size

    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') //=> ' foo bar baz'

    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

    Install

    npm i collapse-white-space

    DownloadsWeekly Downloads

    3,861,489

    Version

    2.1.0

    License

    MIT

    Unpacked Size

    10 kB

    Total Files

    5

    Last publish

    Collaborators

    • wooorm