mute-stream
Advanced tools
- Version published
- Maintainers
- 6
- Weekly downloads
- 23,831,242
- increased by8.42%
Weekly downloads
Changelog
Readme
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
const MuteStream = require('mute-stream')
const 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
const 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.
-
replaceSet to a string to replace each character with the specified string when muted. (So you can show****instead of the password, for example.) -
promptIf you are using a replacement char, and also using a prompt with a readline stream (as for aPassword: *****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.
FAQs
Bytes go in, but they don't come out (when muted).
The npm package mute-stream receives a total of 19,455,664 weekly downloads. As such, mute-stream popularity was classified as popular.
We found that mute-stream demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.