Socket
Socket
Sign inDemoInstall

flush-write-stream

Package Overview
Dependencies
5
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    flush-write-stream

A write stream constructor that supports a flush function that is called before finish is emitted


Version published
Weekly downloads
6.7M
increased by3.12%
Maintainers
1
Install size
186 kB
Created
Weekly downloads
 

Package description

What is flush-write-stream?

The flush-write-stream npm package is a Node.js module that provides a writable stream with a flush function that is called before the 'finish' event is emitted. This allows for any remaining data to be processed or cleanup tasks to be performed before the stream is closed.

What are flush-write-stream's main functionalities?

Creating a writable stream with a flush function

This feature allows you to create a writable stream that will execute a custom flush function before the stream finishes. The flush function is useful for handling any remaining data or performing cleanup tasks.

const FlushWriteStream = require('flush-write-stream');
const writable = FlushWriteStream((data, enc, cb) => {
  // Write data logic
  cb();
}, (cb) => {
  // Flush logic
  cb();
});

Other packages similar to flush-write-stream

Readme

Source

flush-write-stream

A write stream constructor that supports a flush function that is called before finish is emitted

npm install flush-write-stream

build status

Usage

var writer = require('flush-write-stream')

var ws = writer(write, flush)

ws.on('finish', function () {
  console.log('finished')
})

ws.write('hello')
ws.write('world')
ws.end()

function write (data, enc, cb) {
  // i am your normal ._write method
  console.log('writing', data.toString())
  cb()
}

function flush (cb) {
  // i am called before finish is emitted
  setTimeout(cb, 1000) // wait 1 sec
}

If you run the above it will produce the following output

writing hello
writing world
(nothing happens for 1 sec)
finished

API

var ws = writer([options], write, [flush])

Create a new writable stream. Options are forwarded to the stream constructor.

var ws = writer.obj([options], write, [flush])

Same as the above except objectMode is set to true per default.

License

MIT

FAQs

Last updated on 08 Feb 2019

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