REDROOM

Navigation

Breadcrumbs

Create

Edit File Size: 1.12 KB

//lib/node_modules/npm/node_modules/flush-write-stream/README.md

Text Base64

# 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

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
node_modules DIR	-	drwxr-xr-x	2024-03-03 22:36:28	Edit Download recursive recursive
.travis.yml	69 B	lrw-r--r--	2021-03-10 14:36:39	Edit Download recursive recursive
example.js	390 B	lrw-r--r--	2021-03-10 14:36:39	Edit Download recursive recursive
index.js	1.50 KB	lrw-r--r--	2021-03-10 14:36:39	Edit Download recursive recursive
LICENSE	1.05 KB	lrw-r--r--	2021-03-10 14:36:39	Edit Download recursive recursive
package.json	1.69 KB	lrw-r--r--	2021-03-10 14:36:39	Edit Download recursive recursive
README.md	1.12 KB	lrw-r--r--	2021-03-10 14:36:39	Edit Download recursive recursive
test.js	1.56 KB	lrw-r--r--	2021-03-10 14:36:39	Edit Download recursive recursive

Directory Contents