https://github.com/kylepdavis/node-stream-utils
Stream utilities with support for stream resets.
https://github.com/kylepdavis/node-stream-utils
Last synced: about 1 year ago
JSON representation
Stream utilities with support for stream resets.
- Host: GitHub
- URL: https://github.com/kylepdavis/node-stream-utils
- Owner: KylePDavis
- License: mit
- Created: 2012-10-21T23:40:36.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2012-11-19T12:59:43.000Z (over 13 years ago)
- Last Synced: 2025-06-10T11:46:22.669Z (about 1 year ago)
- Language: JavaScript
- Size: 148 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
stream-utils
============
Stream utilities with support for stream resets.
exports
-------
* ThroughStream([write], [end], [reset]) - creates a new "through" Streams which readable and writable that acts based on the given write, end, and reset handler functions.
* DuplexStream(writable, readable) - combines a writable stream and a readable stream into a duplexed Stream.
* Pipeline(stream1, stream2, ...) - creates a new Stream that sends data to all of the given Streams.
Examples
--------
Here's a simple and somewhat contrived example of how you might use the through stream helper to apply a math operation.
``` js
var su = require("stream-utils"),
through = su.ThroughStream;
var inputs = [1, 2, 3],
outputs = [],
doubler = through(function(val){ // on data queue doubled value
this.queue(val * 2);
})
.on("data", function(val2){ // on data push into outputs
outputs.push(val2);
});
inputs.forEach(doubler.write);
// --> outputs is: [2, 4, 6]
```
Why?
----
I needed a set of Stream utilities that would make it easier to build and reuse chains of complex Object stream mutators.
Originally I used the `event-stream` package but I ran into a few issues with my use cases that drove me to roll my own solution based on what I had learned from that code.
License
-------
MIT / Apache2