getpass
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/getpass package

0.1.7 • Public • Published

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

Dependencies (1)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i getpass

    Weekly Downloads

    15,327,965

    Version

    0.1.7

    License

    MIT

    Last publish

    Collaborators

    • bahamat
    • todd.whiteman
    • kusor
    • michael.hicks
    • arekinath