minimal-password-prompt

Minimal hidden password prompt for Node.js! [npm] [github]

Simple, no extra hassles

package	dependencies	dependents	total lines of production code
minimal-password-prompt	0	0	48
password-prompt	2	43	2147

• No dependencies
• Multiplatform: tested on Windows, Linux and macOS
• Minimal: Less than 50 lines of code

Seriously, you can also just copy and paste to your project:

1const stdin = process.stdin;
2const stdout = process.stdout;
3
4const captureStdin = (onData) => {
5  stdin.setEncoding('utf-8');
6  stdin.setRawMode(true);
7  stdin.on('data', onData);
8  stdin.resume();
9};
10
11const releaseStdin = (onData) => {
12  stdin.pause();
13  stdin.removeListener('data', onData);
14  stdin.setRawMode(false);
15  stdout.write('\n');
16};
17
18const prompt = (question, ctrlcExits = true) => (
19  new Promise((resolve, reject) => {
20    let input = '';
21    const onData = (data) => {
22      switch (data) {
23        case '\u000A': // \n
24        case '\u000D': // \r
25        case '\u0004': // Ctrl+D
26          releaseStdin(onData);
27          resolve(input);
28          break;
29        case '\u0003': // Ctrl+C
30          releaseStdin(onData);
31          ctrlcExits // exit or raise error
32            ? process.exit()
33            : reject(new Error('Ctrl+C'));
34          break;
35        case '\u0008': // Backspace
36        case '\u007F': // Delete
37          input = input.slice(0, -1);
38          break;
39        default: // any other
40          input += data;
41      };
42    };
43    captureStdin(onData);
44    stdout.write(question);
45  })
46);
47
48module.exports = prompt;

(please sill do remember to include MIT license/copyright)

Usage

1const prompt = require('minimal-password-prompt');
2
3prompt('enter password: ').then(pw => {
4  console.log(`Password: ${pw}`);
5});

or with async/await:

1const prompt = require('minimal-password-prompt');
2
3(async () => {
4  const pw = await prompt('enter password: ');
5  console.log(`password: ${pw}`);
6})();

More examples here

prompt reference

Parameters:

• question (String) prompt output before user input
• ctrlcExits (Boolean), optional
  • true: Ctrl+C exits program (default)
  • false: Ctrl+C throws error

Returns:

• Promise<String> user input during prompt

Installation

Install with npm:

npm install --save minimal-password-prompt