Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

minipass-flush

Package Overview
Dependencies
1
Maintainers
1
Versions
6
Issues
File Explorer

Advanced tools

minipass-flush

A Minipass stream that calls a flush function before emitting 'end'

    1.0.5latest

Version published
Maintainers
1
Weekly downloads
11,677,608
increased by1.89%

Weekly downloads

Readme

Source

minipass-flush

A Minipass stream that calls a flush function before emitting 'end'

USAGE

const Flush = require('minipass-flush') cons f = new Flush({ flush (cb) { // call the cb when done, or return a promise // the 'end' event will wait for it, along with // close, finish, and prefinish. // call the cb with an error, or return a rejecting // promise to emit 'error' instead of doing the 'end' return rerouteAllEncryptions().then(() => clearAllChannels()) }, // all other minipass options accepted as well }) someDataSource.pipe(f).on('end', () => { // proper flushing has been accomplished }) // Or as a subclass implementing a 'flush' method: class MyFlush extends Flush { flush (cb) { // old fashioned callback style! rerouteAllEncryptions(er => { if (er) return cb(er) clearAllChannels(er => { if (er) cb(er) cb() }) }) } }

That's about it.

If your flush method doesn't have to do anything asynchronous, then it's better to call the callback right away in this tick, rather than returning Promise.resolve(), so that the end event can happen as soon as possible.

Keywords

FAQs

What is minipass-flush?

A Minipass stream that calls a flush function before emitting 'end'

Is minipass-flush popular?

The npm package minipass-flush receives a total of 9,488,205 weekly downloads. As such, minipass-flush popularity was classified as popular.

Is minipass-flush well maintained?

We found that minipass-flush demonstrated a not healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 30 Sep 2019
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc