Add or remove a terminating newline.
_If I should maintain this repo, please ⭐️_
_DM me on [Twitter](https://twitter.com/bconnorwhite) if you have questions or suggestions._
---
Supports both line feeds (/n) and carriage return line feeds (/r/n). Will only add a newline if one does not already exist.
## Installation
```sh
yarn add terminating-newline
```
```sh
npm install terminating-newline
```
```sh
pnpm add terminating-newline
```
## API
### Usage
```ts
import {
addTerminatingNewline,
removeTerminatingNewline,
lineFeed, // "\n"
carriageReturnLineFeed // "/r/n"
} from "terminating-newline";
addTerminatingNewline("abc", { default: lineFeed }); // "abc/n"
addTerminatingNewline("abc\n", { default: lineFeed }); // "abc/n"
removeTerminatingNewline("abc\n"); // "abc"
```
### Types
```ts
function addTerminatingNewline(string: string, options?: Options): string;
function addTerminatingNewline(buffer: Buffer, options?: Options): Buffer;
function removeTerminatingNewline(string: string): string;
function removeTerminatingNewline(buffer: Buffer): Buffer;
type Options = {
// Fallback if newline type cannot be determined. Default: "\n"
default?: LineFeed | CarriageReturnLineFeed;
}
type LineFeed = "\n";
type CarriageReturnLineFeed = "\r\n";
```
Dependencies
- [detect-newline](https://www.npmjs.com/package/detect-newline): Detect the dominant newline character of a string
- [ends-with-string](https://www.npmjs.com/package/ends-with-string): Check if a string or buffer ends with a given string
Dev Dependencies
- [autorepo](https://www.npmjs.com/package/autorepo): Autorepo abstracts away your dev dependencies, providing a single command to run all of your scripts.
License 
[MIT](https://opensource.org/licenses/MIT)
