summaryrefslogtreecommitdiff
path: root/tools/eslint/node_modules/trim-trailing-lines/readme.md
blob: affedf5d8cbef4cc989fc603566b5f1a5a90cf17 (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
43
44
45
46
47
48
49
50
51
52
53
54
55
# trim-trailing-lines [![Build Status][travtrim-trailing-lines]][travis] [![Coverage Status][codecov-badge]][codecov]

Remove final newline characters from a string.

## Installation

[npm][]:

```bash
npm install trim-trailing-lines
```

## Usage

```js
var trimTrailingLines = require('trim-trailing-lines');

trimTrailingLines('foo\nbar'); //=> 'foo\nbar'
trimTrailingLines('foo\nbar\n'); //=> 'foo\nbar'
trimTrailingLines('foo\nbar\n\n'); //=> 'foo\nbar'
```

## API

### `trimTrailingLines(value)`

Remove final newline characters from `value`.

###### Parameters

*   `value` (`string`) — Value with trailing newlines, coerced to string.

###### Returns

`string` — Value without trailing newlines.

## License

[MIT][license] © [Titus Wormer][author]

<!-- Definitions -->

[travtrim-trailing-lines]: https://img.shields.io/travis/wooorm/trim-trailing-lines.svg

[travis]: https://travis-ci.org/wooorm/trim-trailing-lines

[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/trim-trailing-lines.svg

[codecov]: https://codecov.io/github/wooorm/trim-trailing-lines

[npm]: https://docs.npmjs.com/cli/install

[license]: LICENSE

[author]: http://wooorm.com