string-collapse-leading-whitespace

Collapse the leading and trailing whitespace of a string

Usage no npm install needed!

<script type="module">
  import stringCollapseLeadingWhitespace from 'https://cdn.skypack.dev/string-collapse-leading-whitespace';
</script>

README

string-collapse-leading-whitespace

Collapse the leading and trailing whitespace of a string

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required:

npm i string-collapse-leading-whitespace

If you need a legacy version which works with require, use version 5.1.0

Quick Take

import { strict as assert } from "assert";
import { collWhitespace } from "string-collapse-leading-whitespace";

// if leading/trailing whitespace doesn't contain \n, collapse to a single space
assert.equal(collWhitespace("  aaa   "), " aaa ");

// otherwise, collapse to a single \n (default setting)
assert.equal(collWhitespace("     \n\n   aaa  \n\n\n    "), "\naaa\n");

// does nothing to trimmed strings:
assert.equal(collWhitespace("aaa"), "aaa");

// if there are multiple lines string is still processed in trim-fashion -
// only beginning and ending whitespace is changed:
assert.equal(
  collWhitespace("  abc  \n  def  \n  ghi  "),
  " abc  \n  def  \n  ghi "
);

Documentation

Please visit codsen.com for a full description of the API and examples.

Contributing

To report bugs or request features or assistance, raise an issue on GitHub.

Licence

MIT License

Copyright (c) 2010-2021 Roy Revelt and other contributors

ok codsen star