write-only-stream

wrap a readable/writable stream to be write-only to prevent mucking up or disclosing output

example

Suppose you have a module that uses a readable/writable stream internally but want to expose just the writable part of that internal stream. This is common if you use the readable side internally and expose the writable side as the interface.

Now we can write some code like this contrived example with a through stream internally for convenience:

1var through = require('through2');
2var concat = require('concat-stream');
3var writeonly = require('../');
4
5module.exports = function (cb) {
6    var stream = through(function (buf, enc, next) {
7        this.push(buf.toString('utf8').toUpperCase());
8        next();
9    });
10    stream.pipe(concat(cb));
11    return writeonly(stream);
12};

but consumers won't be able to read from the output side:

1var uc = require('./uc.js');
2process.stdin.pipe(uc(function (body) {
3    console.log(body.toString('utf8'));
4})); // can't .pipe() the uc stream anywhere

methods

1var writeonly = require('write-only-stream')

var wo = writeonly(stream)

Return a writable stream wo that wraps the readable/writable stream argument given to only expose the writable side.

stream can be a streams1 or streams2 stream.

install

With npm do:

npm install write-only-stream

license

MIT