through
simplified stream contruction
Last updated 12 years ago .
MIT · Original npm · Tarball · package.json
$ npm install through 
SYNC missed versions from official npm registry.

#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

Current Tags

  • 2.3.8                                ...           latest (9 years ago)

29 Versions

  • 2.3.8                                ...           9 years ago
  • 2.3.7                                ...           10 years ago
  • 2.3.6                                ...           10 years ago
  • 2.3.4                                ...           12 years ago
  • 2.3.3                                ...           12 years ago
  • 2.3.2                                ...           12 years ago
  • 2.3.1                                ...           12 years ago
  • 2.2.7                                ...           12 years ago
  • 2.2.6                                ...           12 years ago
  • 2.2.5                                ...           12 years ago
  • 2.2.4                                ...           12 years ago
  • 2.2.2                                ...           12 years ago
  • 2.2.1                                ...           12 years ago
  • 2.2.0                                ...           12 years ago
  • 2.1.0                                ...           12 years ago
  • 2.0.0                                ...           12 years ago
  • 1.1.2                                ...           12 years ago
  • 1.1.1                                ...           12 years ago
  • 1.1.0                                ...           12 years ago
  • 1.0.0                                ...           12 years ago
  • 0.1.4                                ...           12 years ago
  • 0.1.3                                ...           12 years ago
  • 0.1.2                                ...           12 years ago
  • 0.1.1                                ...           12 years ago
  • 0.1.0                                ...           12 years ago
  • 0.0.4                                ...           12 years ago
  • 0.0.3                                ...           12 years ago
  • 0.0.2                                ...           12 years ago
  • 0.0.1                                ...           12 years ago
Maintainers (1)
Downloads
Total 28
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (0)
None
Dev Dependencies (3)
Dependents (119)

© 2010 - cnpmjs.org x YWFE | Home | YWFE