getpass for node.js
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
deps
lib Change license to MIT Apr 29, 2016
test Change tests to MIT license too Apr 29, 2016
tools Initial boilerplate Apr 21, 2016
.gitignore Initial boilerplate Apr 21, 2016
.gitmodules Initial boilerplate Apr 21, 2016
.npmignore Initial boilerplate Apr 21, 2016
.travis.yml
LICENSE
Makefile
README.md
package.json Update to 0.1.7 (publish to npm without devDeps) Apr 25, 2017

README.md

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

npm install --save getpass
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