@ljharb/resumer
TypeScript icon, indicating that this package has built-in type declarations

0.1.3 • Public • Published

@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

/@ljharb/resumer/

    Package Sidebar

    Install

    npm i @ljharb/resumer

    Weekly Downloads

    122,176

    Version

    0.1.3

    License

    MIT

    Unpacked Size

    13.2 kB

    Total Files

    13

    Last publish

    Collaborators

    • ljharb