aboutsummaryrefslogtreecommitdiff
path: root/node_modules/detect-newline/readme.md
blob: eee16c235d93d7834d25273e3dff18dcdfa67483 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# detect-newline [![Build Status](https://travis-ci.org/sindresorhus/detect-newline.svg?branch=master)](https://travis-ci.org/sindresorhus/detect-newline)

> Detect the dominant newline character of a string


## Install

```
$ npm install detect-newline
```


## Usage

```js
const detectNewline = require('detect-newline');

detectNewline('foo\nbar\nbaz\r\n');
//=> '\n'
```


## API

### detectNewline(string)

Returns the detected newline or `undefined` when no newline character is found.

### detectNewline.graceful(unknown)

Returns the detected newline or `\n` when no newline character is found or the input is not a string.


## Related

- [detect-newline-cli](https://github.com/sindresorhus/detect-newline-cli) - CLI for this module
- [detect-indent](https://github.com/sindresorhus/detect-indent) - Detect the indentation of code


## License

MIT © [Sindre Sorhus](https://sindresorhus.com)