|
1 | | -# trim-trailing-lines [](https://travis-ci.org/wooorm/trim-trailing-lines) [](https://coveralls.io/r/wooorm/trim-trailing-lines?branch=master) |
| 1 | +# trim-trailing-lines [![Build Status][travtrim-trailing-lines]][travis] [![Coverage Status][codecov-badge]][codecov] |
2 | 2 |
|
3 | 3 | Remove final newline characters from a string. |
4 | 4 |
|
5 | 5 | ## Installation |
6 | 6 |
|
7 | | -[npm](https://docs.npmjs.com/cli/install): |
| 7 | +[npm][]: |
8 | 8 |
|
9 | 9 | ```bash |
10 | 10 | npm install trim-trailing-lines |
11 | 11 | ``` |
12 | 12 |
|
13 | | -**trim-trailing-lines** is also available for [bower](http://bower.io/#install-packages), |
14 | | -[component](https://github.com/componentjs/component), [duo](http://duojs.org/#getting-started), |
15 | | -and for AMD, CommonJS, and globals ([uncompressed](trim-trailing-lines.js) and |
16 | | -[compressed](trim-trailing-lines.min.js)). |
17 | | - |
18 | 13 | ## Usage |
19 | 14 |
|
20 | | -Dependencies. |
21 | | - |
22 | | -```javascript |
| 15 | +```js |
23 | 16 | var trimTrailingLines = require('trim-trailing-lines'); |
24 | | -``` |
25 | | - |
26 | | -Trim trailing newline characters: |
27 | 17 |
|
28 | | -```javascript |
29 | | -trimTrailingLines('foo\nbar'); // 'foo\nbar' |
30 | | -trimTrailingLines('foo\nbar\n'); // 'foo\nbar' |
31 | | -trimTrailingLines('foo\nbar\n\n'); // 'foo\nbar' |
| 18 | +trimTrailingLines('foo\nbar'); //=> 'foo\nbar' |
| 19 | +trimTrailingLines('foo\nbar\n'); //=> 'foo\nbar' |
| 20 | +trimTrailingLines('foo\nbar\n\n'); //=> 'foo\nbar' |
32 | 21 | ``` |
33 | 22 |
|
34 | 23 | ## API |
35 | 24 |
|
36 | | -### trimTrailingLines(value) |
| 25 | +### `trimTrailingLines(value)` |
37 | 26 |
|
38 | 27 | Remove final newline characters from `value`. |
39 | 28 |
|
40 | | -Parameters: |
| 29 | +###### Parameters |
41 | 30 |
|
42 | 31 | * `value` (`string`) — Value with trailing newlines, coerced to string. |
43 | 32 |
|
44 | | -Returns: `string` — Value without trailing newlines. |
| 33 | +###### Returns |
| 34 | + |
| 35 | +string\` — Value without trailing newlines. |
45 | 36 |
|
46 | 37 | ## License |
47 | 38 |
|
48 | | -[MIT](LICENSE) @ [Titus Wormer](http://wooorm.com) |
| 39 | +[MIT][license] © [Titus Wormer][author] |
| 40 | + |
| 41 | +<!-- Definitions --> |
| 42 | + |
| 43 | +[travtrim-trailing-lines]: https://img.shields.io/travis/wooorm/trim-trailing-lines.svg |
| 44 | + |
| 45 | +[travis]: https://travis-ci.org/wooorm/trim-trailing-lines |
| 46 | + |
| 47 | +[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/trim-trailing-lines.svg |
| 48 | + |
| 49 | +[codecov]: https://codecov.io/github/wooorm/trim-trailing-lines |
| 50 | + |
| 51 | +[npm]: https://docs.npmjs.com/cli/install |
| 52 | + |
| 53 | +[license]: LICENSE |
| 54 | + |
| 55 | +[author]: http://wooorm.com |
0 commit comments