Skip to content
/ resumer Public

a through stream that starts paused and resumes on the next tick

License

Notifications You must be signed in to change notification settings

ljharb/resumer

Repository files navigation

@ljharb/resumer Version Badge

Note: This package is a fork of https://npmjs.com/resumer, and builds off of it.

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.

github actions coverage License Downloads

npm badge

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('@ljharb/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 @ljharb/resumer

license

MIT

About

a through stream that starts paused and resumes on the next tick

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks