split

Split (matcher)

Break up a stream and reassemble it so that each line is a chunk. matcher may be a String, or a RegExp

Example, read every line in a file ...

  fs.createReadStream(file)
    .pipe(split())
    .on('data', function (line) {
      //each chunk now is a seperate line!
    })

split takes the same arguments as string.split except it defaults to '/\r?\n/' instead of ',', and the optional limit paremeter is ignored. String#split

split takes an optional options object on it's third argument.

  split(matcher, mapper, options)

Valid options:

• maxLength - The maximum buffer length without seeing a newline or matcher, if a single line exceeds this, the split stream will emit an error.

  split(JSON.parse, null, { maxLength: 2})

keep matched splitter

As with Array#split, if you split by a regular expression with a matching group, the matches will be retained in the collection.

stdin
.pipe(split(/(\r?\n)/))
... //lines + separators.

NDJ - Newline Delimited Json

split accepts a function which transforms each line.

fs.createReadStream(file)
  .pipe(split(JSON.parse))
  .on('data', function (obj) {
    //each chunk now is a a js object
  })
  .on('error', function (err) {
    //syntax errors will land here
    //note, this ends the stream.
  })

License

MIT

Similar packages

Other packages similar to split

byline

The 'byline' package is similar to 'split' in that it also provides a way to read a stream line by line. However, 'byline' is specifically focused on lines and does not support custom delimiters.

binary-split

The 'binary-split' package is another alternative to 'split' that is optimized for splitting binary streams. It is similar in functionality but may perform better with binary data.

through2

While 'through2' is not a direct alternative to 'split', it can be used in combination with other stream transformers to achieve similar line splitting functionality. It provides a simple wrapper around Node.js streams Transform to make creating custom transform streams easier.