prompt-password

Password prompt. Can be used as a standalone prompt, or as a plugin for Enquirer.

Install

Install with npm:

1$ npm install --save prompt-password

Usage

1var Prompt = require('..');
2var prompt = new Prompt({
3  type: 'password',
4  message: 'Enter your password please',
5  name: 'password'
6});
7
8prompt.run()
9  .then(function(answers) {
10    console.log(answers)
11  });

mask function

Use prompt-password-strength, or pass a function to customize how the input is masked:

1var Prompt = require('..');
2var prompt = new Prompt({
3  type: 'password',
4  message: 'Enter your password please',
5  name: 'password',
6  mask: function(input) {
7    return '█' + new Array(String(input).length).join('█');
8  }
9});
10
11prompt.run()
12  .then(function(answers) {
13    console.log(answers)
14  });

Enquirer usage

Use the .register method to add the "password" prompt type to enquirer:

1var Enquirer = require('enquirer');
2var enquirer = new Enquirer();
3
4enquirer.register('password', require('prompt-password'));
5
6// questions can be an array or object
7var questions = {
8  type: 'password',
9  message: 'Enter your password please',
10  name: 'password'
11};
12
13enquirer.ask(questions)
14  .then(function(answers) {
15    console.log(answers)
16  });

Attribution

Based on the password prompt in inquirer.

About

Related projects

• enquirer: Intuitive, plugin-based prompt system for node.js. | homepage
• prompt-base: Base prompt module used for creating custom prompts. | homepage
• prompt-question: Question object, used by Enquirer and prompt plugins. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

1$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on June 05, 2017.