diff options
author | 2020-11-18 23:26:45 +0100 | |
---|---|---|
committer | 2020-11-18 23:26:45 +0100 | |
commit | 81ddf9b700bc48a1f8e472209f080f9c1d9a9b09 (patch) | |
tree | 8b959d50c5a614cbf9fcb346ed556140374d4b6d /node_modules/flush-write-stream/README.md | |
parent | 1870f3fdf43707a15fda0f609a021f516f45eb63 (diff) | |
download | website_creator-81ddf9b700bc48a1f8e472209f080f9c1d9a9b09.tar.gz website_creator-81ddf9b700bc48a1f8e472209f080f9c1d9a9b09.tar.bz2 website_creator-81ddf9b700bc48a1f8e472209f080f9c1d9a9b09.zip |
rm node_modules
Diffstat (limited to 'node_modules/flush-write-stream/README.md')
-rw-r--r-- | node_modules/flush-write-stream/README.md | 59 |
1 files changed, 0 insertions, 59 deletions
diff --git a/node_modules/flush-write-stream/README.md b/node_modules/flush-write-stream/README.md deleted file mode 100644 index 7ea7b69..0000000 --- a/node_modules/flush-write-stream/README.md +++ /dev/null @@ -1,59 +0,0 @@ -# flush-write-stream - -A write stream constructor that supports a flush function that is called before `finish` is emitted - -``` -npm install flush-write-stream -``` - -[](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 |