split
    Overview
    Documentation
    Code
    Playground
    Issues
    Insights
    Contributors
    Dependencies
    Versions
    Alternatives

split

split a Text Stream into a Line Stream

1.0.1  •  Published 2 years ago  •  by Dominic Tarr  •  MIT License

build status

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 separate line!
    })

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

split takes an optional options object on its 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})
  • trailing - By default the last buffer not delimited by a newline or matcher will be emitted. To prevent this set options.trailing to false.
  split(JSON.parse, null, { trailing: false })

keep matched splitter

As with String#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

Popularity

Weekly Downloads
3.0M
Stars
337

Maintenance

Development

Last ver 2 years ago
Created 7 years ago
Last commit 2 years ago
1 month between commits

Technology

Node version: 6.5.0
0 unpacked

Legal and Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

16 contributors
Dominic Tarr
Maintainer, 211 commits, 12 merges
Works at Protozoa
Raynos
6 commits
Works at Uber
James Halliday
5 commits, 2 PRs
Works at bits.coop
Michael Hart
4 commits
Works at bustle
Ryan Phillips
3 commits
Tejesh Mehta
2 commits, 1 PRs