https://github.com/dominictarr/through

simple way to create a ReadableWritable stream that works
https://github.com/dominictarr/through

Last synced: 16 days ago
JSON representation

simple way to create a ReadableWritable stream that works

• Host: GitHub
• URL: https://github.com/dominictarr/through
• Owner: dominictarr
• License: other
• Archived: true
• Created: 2012-07-04T14:07:59.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2018-07-27T00:28:29.000Z (over 6 years ago)
• Last Synced: 2024-05-15T13:26:11.857Z (6 months ago)
• Language: JavaScript
• Size: 303 KB
• Stars: 668
• Watchers: 12
• Forks: 64
• Open Issues: 14
• Metadata Files:
  • Readme: readme.markdown
  • License: LICENSE.APACHE2

Awesome Lists containing this project

README

        
#through

[![build status](https://secure.travis-ci.org/dominictarr/through.png)](http://travis-ci.org/dominictarr/through)

[![testling badge](https://ci.testling.com/dominictarr/through.png)](https://ci.testling.com/dominictarr/through)

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](http://github.com/dominictarr/event-stream).

``` js

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')

``` js

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`.

``` js

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