https://github.com/dominictarr/split

https://github.com/dominictarr/split

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/dominictarr/split
• Owner: dominictarr
• License: mit
• Archived: true
• Created: 2012-08-30T14:20:09.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2019-07-02T12:29:19.000Z (over 5 years ago)
• Last Synced: 2024-09-07T02:19:37.023Z (3 months ago)
• Language: JavaScript
• Size: 122 KB
• Stars: 347
• Watchers: 10
• Forks: 39
• Open Issues: 7
• Metadata Files:
  • Readme: readme.markdown

Awesome Lists containing this project

• awesome-nodejs - split - Break up a stream and reassemble it so that each line is a chunk. matcher may be a String, or a RegExp.  (Repository / Streams)
• awesome-nodejs-streams - dominictarr/split - Break up a stream and reassemble it so that each line is a chunk. matcher may be a String, or a RegExp (Modules)

README

        
# Split (matcher)

[![build status](https://secure.travis-ci.org/dominictarr/split.png)](http://travis-ci.org/dominictarr/split)

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 ...

``` js

  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](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String/split)

`split` takes an optional options object on its third argument.

``` js

  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.

``` js

  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`.

``` js

  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.

``` js

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