Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@ljharb/resumer

ljharb668.5kMIT0.1.3TypeScript support: included

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

through, stream, pause, resume

readme

@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

changelog

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v0.1.3 - 2024-03-09

Commits

  • [types] use shared tsconfig ace3782
  • [Robustness] use call-bind rather than .apply f43f860
  • [Dev Deps] update @types/node, tape, typescript; add @arethetypeswrong/cli 95580e2
  • [Deps] update @ljharb/through c421b6f

v0.1.2 - 2024-01-26

Commits

  • [types] mark params as optional e128911

v0.1.1 - 2024-01-26

Commits

v0.1.0 - 2024-01-25

Commits

  • [patch] add types 8aa2f54
  • [meta] update license text so GitHub can identify it d3b4604
  • [Dev Deps] update concat-stream, tape 8f5f559
  • [Dev Deps] update aud, npmignore, tape aab7103
  • [Deps] update @ljharb/through 05c8993
  • [meta] add sideEffects flag 106b1f0

v0.0.1 - 2023-07-17

Commits

  • [meta] add scripts, dev deps, linting; switch from travis to GHA ddf267c
  • [meta] rename package to scoped e63afa4
  • [Dev Deps] update concat-stream, tape b3ef087
  • [Deps] use @ljharb/through instead of through b80960c

v0.0.0 - 2023-07-17

Commits