simple way to create a ReadableWritable stream that works
JavaScript
Latest commit 2c5a6f9 Jul 3, 2015 @dominictarr 2.3.8
Permalink
Failed to load latest commit information.
test fix non-strict null check Apr 6, 2015
.travis.yml Test on 0.10 on Travis Apr 24, 2013
LICENSE.APACHE2 add opensource Jul 4, 2012
LICENSE.MIT add opensource Jul 4, 2012
index.js fix non-strict null check Apr 6, 2015
package.json 2.3.8 Jul 3, 2015
readme.markdown tidy Dec 26, 2013

readme.markdown

through

build status testling badge

Easy way to create a Stream that is both readable and writable.

  • Pass in optional write and end methods.
  • through takes care of pause/resume logic if you use this.queue(data) instead of this.emit('data', data).
  • Use this.pause() and this.resume() to manage flow.
  • Check this.paused to see current flow state. (write always returns !this.paused).

This function is the basis for most of the synchronous streams in event-stream.

var through = require('through')

through(function write(data) {
    this.queue(data) //data *must* not be null
  },
  function end () { //optional
    this.queue(null)
  })

Or, can also be used without buffering on pause, use this.emit('data', data), and this.emit('end')

var through = require('through')

through(function write(data) {
    this.emit('data', data)
    //this.pause() 
  },
  function end () { //optional
    this.emit('end')
  })

Extended Options

You will probably not need these 99% of the time.

autoDestroy=false

By default, through emits close when the writable and readable side of the stream has ended. If that is not desired, set autoDestroy=false.

var through = require('through')

//like this
var ts = through(write, end, {autoDestroy: false})
//or like this
var ts = through(write, end)
ts.autoDestroy = false

License

MIT / Apache2