summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/read/node_modules/mute-stream/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/node_modules/read/node_modules/mute-stream/README.md')
-rw-r--r--deps/npm/node_modules/read/node_modules/mute-stream/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/deps/npm/node_modules/read/node_modules/mute-stream/README.md b/deps/npm/node_modules/read/node_modules/mute-stream/README.md
index 91b45c40c..8ab1238e4 100644
--- a/deps/npm/node_modules/read/node_modules/mute-stream/README.md
+++ b/deps/npm/node_modules/read/node_modules/mute-stream/README.md
@@ -42,6 +42,12 @@ All options are optional.
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.