Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

through

Package Overview
Dependencies
0
Maintainers
1
Versions
29
Issues
File Explorer

Advanced tools

through

simplified stream construction

    2.3.8latest

Version published
Maintainers
1
Weekly downloads
20,799,245
decreased by-11.31%

Weekly downloads

Readme

Source

#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

Keywords

FAQs

What is through?

simplified stream construction

Is through popular?

The npm package through receives a total of 16,020,888 weekly downloads. As such, through popularity was classified as popular.

Is through well maintained?

We found that through demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 03 Jul 2015

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc