1
0
mirror of https://github.com/thangisme/notes.git synced 2024-11-18 07:55:54 -05:00
notes/node_modules/trim-newlines/readme.md

47 lines
953 B
Markdown
Raw Normal View History

2017-03-09 13:16:08 -05:00
# trim-newlines [![Build Status](https://travis-ci.org/sindresorhus/trim-newlines.svg?branch=master)](https://travis-ci.org/sindresorhus/trim-newlines)
> Trim [newlines](https://en.wikipedia.org/wiki/Newline) from the start and/or end of a string
## Install
```
$ npm install --save trim-newlines
```
## Usage
```js
var trimNewlines = require('trim-newlines');
trimNewlines('\nunicorn\r\n');
//=> 'unicorn'
```
## API
### trimNewlines(input)
Trim from the start and end of a string.
### trimNewlines.start(input)
Trim from the start of a string.
### trimNewlines.end(input)
Trim from the end of a string.
## Related
- [trim-left](https://github.com/sindresorhus/trim-left) - Similar to `String#trim()` but removes only whitespace on the left
- [trim-right](https://github.com/sindresorhus/trim-right) - Similar to `String#trim()` but removes only whitespace on the right.
## License
MIT © [Sindre Sorhus](http://sindresorhus.com)