diff options
Diffstat (limited to 'school/node_modules/string-collapse-leading-whitespace/README.md')
-rw-r--r-- | school/node_modules/string-collapse-leading-whitespace/README.md | 70 |
1 files changed, 0 insertions, 70 deletions
diff --git a/school/node_modules/string-collapse-leading-whitespace/README.md b/school/node_modules/string-collapse-leading-whitespace/README.md deleted file mode 100644 index 98cb999..0000000 --- a/school/node_modules/string-collapse-leading-whitespace/README.md +++ /dev/null @@ -1,70 +0,0 @@ -# string-collapse-leading-whitespace - -> Collapse the leading and trailing whitespace of a string - -<div class="package-badges"> - <a href="https://www.npmjs.com/package/string-collapse-leading-whitespace" rel="nofollow noreferrer noopener"> - <img src="https://img.shields.io/badge/-npm-blue?style=flat-square" alt="page on npm"> - </a> - <a href="https://codsen.com/os/string-collapse-leading-whitespace" rel="nofollow noreferrer noopener"> - <img src="https://img.shields.io/badge/-codsen-blue?style=flat-square" alt="page on codsen.com"> - </a> - <a href="https://github.com/codsen/codsen/tree/main/packages/string-collapse-leading-whitespace" rel="nofollow noreferrer noopener"> - <img src="https://img.shields.io/badge/-github-blue?style=flat-square" alt="page on github"> - </a> - <a href="https://npmcharts.com/compare/string-collapse-leading-whitespace?interval=30" rel="nofollow noreferrer noopener" target="_blank"> - <img src="https://img.shields.io/npm/dm/string-collapse-leading-whitespace.svg?style=flat-square" alt="Downloads per month"> - </a> - <a href="https://prettier.io" rel="nofollow noreferrer noopener" target="_blank"> - <img src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg?style=flat-square" alt="Code style: prettier"> - </a> - <img src="https://img.shields.io/badge/licence-MIT-brightgreen.svg?style=flat-square" alt="MIT License"> - <a href="https://liberamanifesto.com" rel="nofollow noreferrer noopener" target="_blank"> - <img src="https://img.shields.io/badge/libera-manifesto-lightgrey.svg?style=flat-square" alt="libera manifesto"> - </a> -</div> - -## Install - -```bash -npm i string-collapse-leading-whitespace -``` - -## Quick Take - -```js -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](https://codsen.com/os/string-collapse-leading-whitespace/) for a full description of the API and examples. - -## Contributing - -To report bugs or request features or assistance, [raise an issue](https://github.com/codsen/codsen/issues/new/choose) on GitHub. - -## Licence - -MIT License - -Copyright (c) 2010-2021 Roy Revelt and other contributors - -<img src="https://codsen.com/images/png-codsen-ok.png" width="98" alt="ok" align="center"> <img src="https://codsen.com/images/png-codsen-1.png" width="148" alt="codsen" align="center"> <img src="https://codsen.com/images/png-codsen-star-small.png" width="32" alt="star" align="center"> |