Gecko [ oric.aiou.edu.pk ]

Name	Size	Permission
examples	[ DIR ]	drwxr-xr-x
README.md	1.12 KB	-rw-r--r--
changelog.Debian.gz	696 B	-rw-r--r--
copyright	1.43 KB	-rw-r--r--

# 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](http://img.shields.io/travis/mafintosh/flush-write-stream.svg?style=flat)](http://travis-ci.org/mafintosh/flush-write-stream)

## Usage

``` js
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