Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

split

Package Overview
Dependencies
1
Maintainers
1
Versions
20
Issues
File Explorer

Advanced tools

split

split a Text Stream into a Line Stream

    1.0.1latest

Version published
Maintainers
1
Weekly downloads
7,405,592
decreased by-11.41%

Weekly downloads

Readme

Source

Split (matcher)

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

FAQs

What is split?

split a Text Stream into a Line Stream

Is split popular?

The npm package split receives a total of 7,061,686 weekly downloads. As such, split popularity was classified as popular.

Is split well maintained?

We found that split demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 03 Aug 2017

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc