rmlines
v2.0.0
Published
Streaming line remover
Downloads
13
Readme
rmlines
Streaming line remover
rmlines
is a Transform stream that remove lines (based on line numbers) from any string.
Install
$ npm install --save rmlines
Usage
Suppose a file named example.txt
containing the following:
abc
def
ghi
jkl
mno
then, rmlines()
returns a transform stream that accepts strings and emits the string without unwanted lines (here: line 2 and line 4)
const rmlines = require('rmlines');
let txt = '';
fs.createReadStream('example.txt')
.pipe(rmlines([2, 4]))
.on('data', function (data) {
txt += data;
}).on('end', function () {
console.log((txt === 'abc\nghi\nmno\n'));
// => true
});
Options
maxLength
Type: integer
Set a buffer size limit.
API
rmlines(lines, [options])
lines
Type: integer|array
The number(s) of the line(s) that must be removed.
options
Type: object
as described above
Related
- rmlines-cli | CLI for rmlines
- gulp-rmlines | rmlines as a
gulp
plugin - gulp-rmlines | rmlines as a
Grunt
plugin
License
MIT © t1st3