https://github.com/wooorm/trim-lines
Remove spaces and tabs around line-breaks
https://github.com/wooorm/trim-lines
break line trim
Last synced: 2 months ago
JSON representation
Remove spaces and tabs around line-breaks
- Host: GitHub
- URL: https://github.com/wooorm/trim-lines
- Owner: wooorm
- License: mit
- Created: 2015-07-12T15:41:23.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2022-11-23T13:02:10.000Z (over 2 years ago)
- Last Synced: 2025-03-30T03:09:45.062Z (3 months ago)
- Topics: break, line, trim
- Language: JavaScript
- Homepage:
- Size: 70.3 KB
- Stars: 51
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: funding.yml
- License: license
Awesome Lists containing this project
README
# trim-lines
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
Remove initial and final spaces and tabs around line endings in a value.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`trimLines(value)`](#trimlinesvalue)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [License](#license)
## What is this?
This package is a tiny utility that removes initial and final spaces and tabs
around line endings in a value, keeping the line endings themselves, while not
removing whitespace at the start or end of the entire string.
It might look trivial, but it’s actually pretty complex to get performant.
## When should I use this?
When you need to trim markdown-like whitespace around line endings and don’t
want to run into performance problems.
## Install
This package is [ESM only][esm].
In Node.js (version 14.14+, 16.0+), install with [npm][]:
```sh
npm install trim-lines
```
In Deno with [`esm.sh`][esmsh]:
```js
import trimLines from 'https://esm.sh/trim-lines@3'
```
In browsers with [`esm.sh`][esmsh]:
```html
import trimLines from 'https://esm.sh/trim-lines@3?bundle'
```
## Use
```js
import {trimLines} from 'trim-lines'
console.log(trimLines(' foo\t\n\n bar \n\tbaz ')) // => ' foo\n\nbar\nbaz '
```
## API
This package exports the identifier `trimLines`.
There is no default export.
### `trimLines(value)`
Remove initial and final spaces and tabs around line endings in `value`
(`string`).
Does not trim initial and final spaces and tabs of the value itself.
## Types
This package is fully typed with [TypeScript][].
It exports no additional types.
## Compatibility
This package is at least compatible with all maintained versions of Node.js.
As of now, that is Node.js 14.14+ and 16.0+.
It also works in Deno and modern browsers.
## Security
This package is safe.
## Contribute
Yes please!
See [How to Contribute to Open Source][contribute].
## License
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/wooorm/trim-lines/workflows/main/badge.svg
[build]: https://github.com/wooorm/trim-lines/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/trim-lines.svg
[coverage]: https://codecov.io/github/wooorm/trim-lines
[downloads-badge]: https://img.shields.io/npm/dm/trim-lines.svg
[downloads]: https://www.npmjs.com/package/trim-lines
[size-badge]: https://img.shields.io/bundlephobia/minzip/trim-lines.svg
[size]: https://bundlephobia.com/result?p=trim-lines
[npm]: https://docs.npmjs.com/cli/install
[license]: license
[author]: https://wooorm.com
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[typescript]: https://www.typescriptlang.org
[contribute]: https://opensource.guide/how-to-contribute/