Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcollina/reduplexer
reduplexer(writable, readable, options)
https://github.com/mcollina/reduplexer
Last synced: 12 days ago
JSON representation
reduplexer(writable, readable, options)
- Host: GitHub
- URL: https://github.com/mcollina/reduplexer
- Owner: mcollina
- License: isc
- Created: 2014-03-13T08:34:32.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2014-12-17T22:34:18.000Z (about 10 years ago)
- Last Synced: 2024-12-25T09:34:19.825Z (15 days ago)
- Language: JavaScript
- Size: 211 KB
- Stars: 13
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# reduplexer(writable, readable, options)
[![build status][1]][2]
Takes a [`Writable`][5] stream and a [`Readable`][4] stream and makes them appear as a `Duplex` stream.
Heavily inspired by [duplexer](http://npm.im/duplexer) but using Stream2
with a bundled [readable-stream](http://npm.im/readable-stream).
It is assumed that the two streams are connected to each other in some way.
## Example
```js
var cp = require('child_process')
, duplexer = require('reduplexer')
, grep = cp.exec('grep Stream')
duplexer(grep.stdin, grep.stdout, { objectMode: true })
```
## Installation
`npm install reduplexer --save`
## API
* reduplexer()
* duplex.hookWritable()
* duplex.hookReadable()
* duplex.hook()
-------------------------------------------------------
### reduplexer(writable, readable, options)
Create a [`Duplex`][3] stream based on `writable` and `readable` using
the given options.
`writable` and `readable` can be null, and in that case they can be
'hooked' later.
-------------------------------------------------------
### duplex.hookWritable(writable)
Hooks a `Writable` stream. It will throw if a `Writable` is already hooked.
-------------------------------------------------------
### duplex.hookReadable(writable)
Hooks a `Readable` stream. It will throw if a `Readable` stream is already hooked.
-------------------------------------------------------
### duplex.hook(writable, readable)
Shortcut for:
```js
duplex.hookWritable(writable)
duplex.hookReadable(readable)
```
But it will not throw if any of the two are missing.
## Tests
`npm test`
## License
Copyright (c) 2014, Matteo Collina
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
[1]: https://secure.travis-ci.org/mcollina/reduplexer.png
[2]: https://travis-ci.org/mcollina/reduplexer
[3]: http://nodejs.org/api/stream.html#stream_class_stream_duplex
[4]: http://nodejs.org/api/stream.html#stream_class_stream_readable
[5]: http://nodejs.org/api/stream.html#stream_class_stream_writable