Blame view

node_modules/flush-write-stream/README.md 1.12 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
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
  ```
  
  [![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