Socket
Socket
Sign inDemoInstall

pause-stream

Package Overview
Dependencies
1
Maintainers
1
Versions
11
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

pause-stream

a ThroughStream that strictly buffers all readable events when paused.


Version published
Maintainers
1
Weekly downloads
3,578,217
decreased by-8.58%

Weekly downloads

Package description

What is pause-stream?

The pause-stream package is a Node.js module that allows you to pause and resume streaming data. It is particularly useful in scenarios where you need to control the flow of data, for example, when processing or transforming data in chunks. It provides a simple API to pause the data stream, process the current chunk of data, and then resume the stream when ready.

What are pause-stream's main functionalities?

Pausing and resuming a stream

This feature allows you to pause the flow of data in a stream and then resume it. The code sample demonstrates how to create a readable stream from a file, pipe it through a pause-stream, pause the stream to process data, and then resume the stream.

"use strict";
const pause = require('pause-stream')();
const fs = require('fs');

let dataStream = fs.createReadStream('data.txt');
dataStream.pipe(pause);

pause.pause();
// Process data here
pause.resume();

Other packages similar to pause-stream

Readme

Source

PauseStream

This is a Stream that will strictly buffer when paused. Connect it to anything you need buffered.

  var ps = require('pause-stream')();

  badlyBehavedStream.pipe(ps.pause())

  aLittleLater(function (err, data) {
    ps.pipe(createAnotherStream(data))
    ps.resume()
  })

PauseStream will buffer whenever paused. it will buffer when yau have called pause manually. but also when it's downstream dest.write()===false. it will attempt to drain the buffer when you call resume or the downstream emits 'drain'

PauseStream is tested using stream-spec and stream-tester

This is now the default case of through

https://github.com/dominictarr/pause-stream/commit/4a6fe3dc2c11091b1efbfde912e0473719ed9cc0

Keywords

FAQs

Last updated on 20 Sep 2013

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc