Blame view

node_modules/mute-stream/README.md 1.61 KB
ce4c83ff   wxy   初始提交
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
60
61
62
63
64
65
66
67
68
  # mute-stream
  
  Bytes go in, but they don't come out (when muted).
  
  This is a basic pass-through stream, but when muted, the bytes are
  silently dropped, rather than being passed through.
  
  ## Usage
  
  ```javascript
  var MuteStream = require('mute-stream')
  
  var ms = new MuteStream(options)
  
  ms.pipe(process.stdout)
  ms.write('foo') // writes 'foo' to stdout
  ms.mute()
  ms.write('bar') // does not write 'bar'
  ms.unmute()
  ms.write('baz') // writes 'baz' to stdout
  
  // can also be used to mute incoming data
  var ms = new MuteStream
  input.pipe(ms)
  
  ms.on('data', function (c) {
    console.log('data: ' + c)
  })
  
  input.emit('data', 'foo') // logs 'foo'
  ms.mute()
  input.emit('data', 'bar') // does not log 'bar'
  ms.unmute()
  input.emit('data', 'baz') // logs 'baz'
  ```
  
  ## Options
  
  All options are optional.
  
  * `replace` Set to a string to replace each character with the
    specified string when muted.  (So you can show `****` instead of the
    password, for example.)
  
  * `prompt` If you are using a replacement char, and also using a
    prompt with a readline stream (as for a `Password: *****` input),
    then specify what the prompt is so that backspace will work
    properly.  Otherwise, pressing backspace will overwrite the prompt
    with the replacement character, which is weird.
  
  ## ms.mute()
  
  Set `muted` to `true`.  Turns `.write()` into a no-op.
  
  ## ms.unmute()
  
  Set `muted` to `false`
  
  ## ms.isTTY
  
  True if the pipe destination is a TTY, or if the incoming pipe source is
  a TTY.
  
  ## Other stream methods...
  
  The other standard readable and writable stream methods are all
  available.  The MuteStream object acts as a facade to its pipe source
  and destination.