summaryrefslogtreecommitdiffstats
path: root/node_modules/getpass/README.md
diff options
context:
space:
mode:
authorGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
committerGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
commite06ec920f7a5d784e674c4c4b4e6d1da3dc7391d (patch)
tree55713f725f77b44ebfec86e4eec3ce33e71458ca /node_modules/getpass/README.md
downloadwebsite_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.gz
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.bz2
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.zip
api, login, auth
Diffstat (limited to 'node_modules/getpass/README.md')
-rw-r--r--node_modules/getpass/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/node_modules/getpass/README.md b/node_modules/getpass/README.md
new file mode 100644
index 0000000..6e4a50f
--- /dev/null
+++ b/node_modules/getpass/README.md
@@ -0,0 +1,32 @@
+## getpass
+
+Get a password from the terminal. Sounds simple? Sounds like the `readline`
+module should be able to do it? NOPE.
+
+## Install and use it
+
+```bash
+npm install --save getpass
+```
+
+```javascript
+const mod_getpass = require('getpass');
+```
+
+## API
+
+### `mod_getpass.getPass([options, ]callback)`
+
+Gets a password from the terminal. If available, this uses `/dev/tty` to avoid
+interfering with any data being piped in or out of stdio.
+
+This function prints a prompt (by default `Password:`) and then accepts input
+without echoing.
+
+Parameters:
+
+ * `options`, an Object, with properties:
+ * `prompt`, an optional String
+ * `callback`, a `Func(error, password)`, with arguments:
+ * `error`, either `null` (no error) or an `Error` instance
+ * `password`, a String