trim-trailing-lines
Remove final line endings from a string.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Contribute
- Security
- License
What is this?
This is a tiny package that removes final line endings (CR, LF, CR+LF) from a string.
When should I use this?
This package is rather niche, I found myself repeating this code when working with a lot of markdown.
Install
This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:
npm install trim-trailing-lines
In Deno with esm.sh
:
import {trimTrailingLines} from 'https://esm.sh/trim-trailing-lines@2'
In browsers with esm.sh
:
<script type="module">
import {trimTrailingLines} from 'https://esm.sh/trim-trailing-lines@2?bundle'
</script>
Use
import {trimTrailingLines} from 'trim-trailing-lines'
trimTrailingLines('foo\nbar') // => 'foo\nbar'
trimTrailingLines('foo\nbar\n') // => 'foo\nbar'
trimTrailingLines('foo\nbar\n\n') // => 'foo\nbar'
API
This package exports the identifier trimTrailingLines
.
There is no default export.
trimTrailingLines(value)
Remove final line endings from value
.
Parameters
valeu
Value with trailing line endings, coerced to string (unknown
).
Returns
Value without trailing line endings (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+ and 16.0+. It also works in Deno and modern browsers.
Contribute
Yes please! See How to Contribute to Open Source.
Security
This package is safe.