mirror of
https://github.com/shimataro/ssh-key-action.git
synced 2025-06-19 22:52:10 +10:00
* first action!
This commit is contained in:
parent
8deacc95b1
commit
4e3aad3b7f
3750 changed files with 1155519 additions and 0 deletions
59
node_modules/flush-write-stream/README.md
generated
vendored
Normal file
59
node_modules/flush-write-stream/README.md
generated
vendored
Normal file
|
@ -0,0 +1,59 @@
|
|||
# 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
|
Loading…
Add table
Add a link
Reference in a new issue