prompt-password

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

Install

Install with npm:

$ npm install --save prompt-password

Usage

var Prompt = require('..');
var prompt = new Prompt({
  type: 'password',
  message: 'Enter your password please',
  name: 'password'
});

prompt.run()
  .then(function(answers) {
    console.log(answers)
  });

mask function

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

var Prompt = require('..');
var prompt = new Prompt({
  type: 'password',
  message: 'Enter your password please',
  name: 'password',
  mask: function(input) {
    return '█' + new Array(String(input).length).join('█');
  }
});

prompt.run()
  .then(function(answers) {
    console.log(answers)
  });

Enquirer usage

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

var Enquirer = require('enquirer');
var enquirer = new Enquirer();

enquirer.register('password', require('prompt-password'));

// questions can be an array or object
var questions = {
  type: 'password',
  message: 'Enter your password please',
  name: 'password'
};

enquirer.ask(questions)
  .then(function(answers) {
    console.log(answers)
  });

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:

$ 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.