Remove initial and final spaces and tabs around line endings in a value.

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

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 you need to trim markdown-like whitespace around line endings and don’t want to run into performance problems.

This package is ESM only. In Node.js (version 14.14+, 16.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>

import {trimLines} from 'trim-lines'

console.log(trimLines(' foo\t\n\n bar \n\tbaz ')) // => ' foo\n\nbar\nbaz '

This package exports the identifier trimLines. There is no default export.

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.

This package is fully typed with TypeScript. It exports no additional types.

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.

This package is safe.

Yes please! See How to Contribute to Open Source.

MIT © Titus Wormer