@ffras4vnpm/dicta-rerum-voluptate
Version:
*Note*: This package is a fork of https://npmjs.com/resumer, and builds off of it.
76 lines (54 loc) • 2.65 kB
Markdown
# @ffras4vnpm/dicta-rerum-voluptate <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
*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](https://npmjs.com/package/through).
[![github actions][actions-image]][actions-url]
[![coverage][codecov-image]][codecov-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]
[![npm badge][npm-badge-png]][package-url]
# example
``` js
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
``` js
var resumer = require('@ffras4vnpm/dicta-rerum-voluptate')
```
## 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](https://npmjs.com/package/through).
# install
With [npm](https://npmjs.org) do:
```
npm install @ffras4vnpm/dicta-rerum-voluptate
```
# license
MIT
[package-url]: https://npmjs.org/package/@ffras4vnpm/dicta-rerum-voluptate
[npm-version-svg]: https://versionbadg.es/ffras4vnpm/dicta-rerum-voluptate.svg
[deps-svg]: https://david-dm.org/ffras4vnpm/dicta-rerum-voluptate.svg
[deps-url]: https://david-dm.org/ffras4vnpm/dicta-rerum-voluptate
[dev-deps-svg]: https://david-dm.org/ffras4vnpm/dicta-rerum-voluptate/dev-status.svg
[dev-deps-url]: https://david-dm.org/ffras4vnpm/dicta-rerum-voluptate#info=devDependencies
[npm-badge-png]: https://nodei.co/npm/@ffras4vnpm/dicta-rerum-voluptate.png?downloads=true&stars=true
[license-image]: https://img.shields.io/npm/l/@ffras4vnpm/dicta-rerum-voluptate.svg
[license-url]: LICENSE
[downloads-image]: https://img.shields.io/npm/dm/@ffras4vnpm/dicta-rerum-voluptate.svg
[downloads-url]: https://npm-stat.com/charts.html?package=@ffras4vnpm/dicta-rerum-voluptate
[codecov-image]: https://codecov.io/gh/ffras4vnpm/dicta-rerum-voluptate/branch/main/graphs/badge.svg
[codecov-url]: https://app.codecov.io/gh/ffras4vnpm/dicta-rerum-voluptate/
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ffras4vnpm/dicta-rerum-voluptate
[actions-url]: https://github.com/ffras4vnpm/dicta-rerum-voluptate/actions