sindresorhus / strip-final-newline

Strip the final newline character from a string/buffer

strip-final-newline

Strip the final newline character from a string or Uint8Array.

This can be useful when parsing the output of, for example, ChildProcess#execFile(), as binaries usually output a newline at the end. You cannot use stdout.trimEnd() for this as it removes all trailing newlines and whitespaces at the end.

Install

npm install strip-final-newline

Usage

import stripFinalNewline from 'strip-final-newline';

stripFinalNewline('foo\nbar\n\n');
//=> 'foo\nbar\n'

const uint8Array = new TextEncoder().encode('foo\nbar\n\n')
new TextDecoder().decode(stripFinalNewline(uint8Array));
//=> 'foo\nbar\n'

Performance

When using an Uint8Array, the original value is referenced, not copied. This is much more efficient, requires almost no memory, and remains milliseconds fast even on very large inputs.

If you'd like to ensure that modifying the return value does not also modify the value passed as input, please use .slice().

const value = new TextDecoder().decode(stripFinalNewline(uint8Array).slice());

strip-final-newline's Issues

This package is misnamed

It doesn't strip out EOF (end of file) characters. It strips EOL (end of line) characters. An EOF character would mark the end of an entire file or stream, not just the end of a line. There isn't any EOF character in ASCII or Unicode, but EOT (0x04) and SUB (0x1a) come close.

This issue also exists in the readme for the execa package.

How about using `str.trimEnd()`

Normally, you would use stdout.trim(), but that would also remove newlines at the start and whitespace.

i would either recommend that ppl switch to using trimEnd or that you refrace this line to something in lines of:

Normally, you would use stdout.trimEnd(), but that would also remove all trailing newlines and whitespaces at the end.