trim-lines

trim-lines

Remove spaces and tabs around line breaks.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • trimLines(value)
• Types
• Compatibility
• Contribute
• License

What is this?

This package is a tiny utility that removes spaces and tabs around line endings, keeping the line endings, and not removing whitespace at the start or end of the 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. In Node.js (version 14.14+, 16.0+, or 18.0+), install with npm:

npm install trim-lines

In Deno with esm.sh:

import trimLines from 'https://esm.sh/trim-lines@3'

In browsers with esm.sh:

<script type="module">
  import trimLines from 'https://esm.sh/trim-lines@3?bundle'
</script>

Use

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 spaces and tabs around line breaks in value (string).

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+, 16.0+, and 18.0+. It also works in Deno and modern browsers.

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer