flush-write-stream
A write stream constructor that supports a flush function that is called before finish is emitted
Last updated 2 years ago by mafintosh .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install flush-write-stream 
SYNC missed versions from official npm registry.

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

Current Tags

  • 2.0.0                                ...           latest (2 years ago)

7 Versions

  • 2.0.0                                ...           2 years ago
  • 1.1.1                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.3                                ...           3 years ago
  • 1.0.2                                ...           4 years ago
  • 1.0.1                                ...           4 years ago
  • 1.0.0                                ...           5 years ago
Maintainers (1)
Downloads
Today 6,672
This Week 174,782
This Month 380,159
Last Day 31,508
Last Week 184,060
Last Month 883,666
Dependencies (2)
Dev Dependencies (1)
Dependents (97)

Copyright 2014 - 2017 © taobao.org |