https://github.com/indiependente/chunknlines

Node.js n-lines splitter stream module
https://github.com/indiependente/chunknlines

Last synced: 5 days ago
JSON representation

Node.js n-lines splitter stream module

• Host: GitHub
• URL: https://github.com/indiependente/chunknlines
• Owner: indiependente
• License: mit
• Created: 2014-08-09T17:48:36.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-08-10T17:07:03.000Z (over 10 years ago)
• Last Synced: 2024-12-11T09:45:11.673Z (26 days ago)
• Language: JavaScript
• Size: 371 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
chunknlines

===========

Node.js n-lines chunker stream module

##What it does

This stream helps you create chunks from an input. It's very useful when dealing with big files.

This module takes text in input and sends in output chunk made by n-lines. Where n is the only argument that it needs, but it can be omitted. Simple.

##Usage

var chunknlines 	= 	require('chunknlines');

stream.pipe(chunknlines([NLINES]).pipe(anotherstream);

#####Argument:

- NLINES: the number of lines in a single chunk (default = 1)

##Example

The example code below, echoes what we write on standard input every 3 new lines.

```javascript

var chunknlines 	= 	require('chunknlines');

process.stdin.pipe(chunknlines(3)).pipe(process.stdout);

```

##License

####MIT