# convert-newline

> Unify newline characters to either \n, \r\n, or \r.

Latest version **0.0.5** (published 2015-05-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install convert-newline
pnpm add convert-newline
yarn add convert-newline
bun add convert-newline
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2015-05-12 |
| First published | 2015-05-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Takeshi Kurosawa |
| Maintainers | takenspc |

## Links

- npm: https://www.npmjs.com/package/convert-newline
- Repository: https://github.com/takenspc/convert-newline
- Homepage: https://github.com/takenspc/convert-newline/
- Issues: https://github.com/takenspc/convert-newline/issues
- npm.io page: https://npm.io/package/convert-newline

## Dependencies (1)

- [iconv-lite](https://npm.io/package/iconv-lite.md) ^0.4.8

## Recent versions

- 0.0.5 (latest) — 2015-05-12
- 0.0.4 — 2015-05-11
- 0.0.3 — 2015-05-10
- 0.0.2 — 2015-05-09
- 0.0.1 — 2015-05-09

## README

# convert-newline

[![Build Status](https://travis-ci.org/takenspc/convert-newline.svg?branch=master)](https://travis-ci.org/takenspc/convert-newline)
[![Build status](https://ci.appveyor.com/api/projects/status/x4ks2y09jcjfvgw8/branch/master?svg=true)](https://ci.appveyor.com/project/takenspc/convert-newline/branch/master)
[![Coverage Status](https://coveralls.io/repos/takenspc/convert-newline/badge.svg?branch=master)](https://coveralls.io/r/takenspc/convert-newline?branch=master)

Unify newline characters to either `\n`,`\r\n`, or `\r`.

## Usage

### String

```js
var convertNewline = require("convert-newline");

var converter = convertNewline("lf").string();
converter("aaa\rbbb\r\nccc\n"); // -> "aaa\nbbb\nccc\n"
```

### Buffer

```js
var convertNewline = require("convert-newline");
var buffer = new Buffer("aaa\rbbb\r\nccc\n");

var converter = convertNewline("lf").buffer();
var newBuffer = converter(buffer);

newBuffer.toString(); // -> "aaa\nbbb\nccc\n"
```

Converting non-utf8 encoded buffers is supported.

```js
var iconv = require("iconv-lite");
var convertNewline = require("convert-newline");
var buffer = iconv.encode(new Buffer("あ\rい\r\nう\n"), "shift_jis");

var converter = convertNewline("lf", "shift_jis").buffer();
var newBuffer = converter(buffer);

iconv.decode(newBuffer, "shift_jis"); // -> "あ\nい\nう\n"
```

### Stream

```js
var fs = require("fs");
var convertNewline = require("convert-newline");
var reader = fs.createReadStream("foo.txt", { encoding: "utf8" });
var writer = fs.createWriteStream("bar.txt");

var converter = convertNewline("lf").stream();
reader
	.pipe(converter)
	.pipe(writer);
```

To convert non-utf8 encoded streams, you can use [iconv-lite](https://github.com/ashtuchkin/iconv-lite/).

```js
var fs = require("fs");
var iconv = require("iconv-lite");
var convertNewline = require("convert-newline");
var reader = fs.createReadStream("foo.txt");
var writer = fs.createWriteStream("bar.txt");

var converter = convertNewline("lf").stream();
reader
	.pipe(iconv.decodeStream("shift_jis"))
	.pipe(converter)
	.pipe(iconv.encodeStream("shift_jis"))
	.pipe(writer);
```

## API

### convertNewline(newline, encoding)

#### newline

Target newline characters. Either `"lf"`, `"crlf"`, or `"cr"`.

### encoding

Optional. The encoding of the buffer.

[Supported encodings](https://github.com/ashtuchkin/iconv-lite/wiki/Supported-Encodings) are listed on the [iconv-lite](https://github.com/ashtuchkin/iconv-lite/) wiki.

---
_Source: https://npm.io/package/convert-newline · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._