www.aleph1.co.uk Git - yaffs-website/blob - node_modules/linerstream/README.md

   1 # linerstream
   2
   3 Split a readable stream by newline characters
   4
   5 [![NPM](https://nodei.co/npm/linerstream.png)](https://nodei.co/npm/linerstream/)
   6
   7 [![Build Status](https://travis-ci.org/nisaacson/linerstream.png)](https://travis-ci.org/nisaacson/linerstream)
   8 [![Dependency Status](https://david-dm.org/nisaacson/linerstream/status.png)](https://david-dm.org/nisaacson/linerstream)
   9 [![Code Climate](https://codeclimate.com/github/nisaacson/linerstream.png)](https://codeclimate.com/github/nisaacson/linerstream)
  10
  11 # Installation
  12 ```bash
  13 npm install -S linerstream
  14 ```
  15
  16 # Usage
  17
  18 Create an instance of linestream and pipe a readable stream into that instance
  19
  20 ```javascript
  21 var Linerstream = require('linerstream')
  22 // splitter is an instance of require('stream').Transform
  23 var opts = {
  24   highWaterMark: 2
  25 }
  26 var splitter = new Linerstream(opts) // opts is optional
  27
  28 var readStream = fs.createReadStream('/file/with/line/breaks.txt')
  29 var lineByLineStream = readStream.pipe(splitter)
  30 lineByLineStream.on('data', function(chunk) {
  31   console.dir(chunk)  // no line breaks here :)
  32 })
  33 ```
  34
  35
  36