readme.markdown 1.15 KB

resumer

Return a through stream that starts out paused and resumes on the next tick, unless somebody called .pause().

This module has the same signature as through.

browser support

build status

example

var resumer = require('resumer');
var s = createStream();
s.pipe(process.stdout);

function createStream () {
    var stream = resumer();
    stream.queue('beep boop\n');
    return stream;
}
$ node example/resume.js
beep boop

methods

var resumer = require('resumer')

resumer(write, end)

Return a new through stream from write and end, which default to pass-through .queue() functions if not specified.

The stream starts out paused and will be resumed on the next tick unless you call .pause() first.

write and end get passed directly through to through.

install

With npm do:

npm install resumer

license

MIT