to2

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

npm install to2

This module is an alias of flush-write-stream for better symmetry with from2.

Usage

1var writer = require('to2')
2
3var ws = writer(write, flush)
4
5ws.on('finish', function () {
6  console.log('finished')
7})
8
9ws.write('hello')
10ws.write('world')
11ws.end()
12
13function write (data, enc, cb) {
14  // i am your normal ._write method
15  console.log('writing', data.toString())
16  cb()
17}
18
19function flush (cb) {
20  // i am called before finish is emitted
21  setTimeout(cb, 1000) // wait 1 sec
22}

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