Skip to content

This repository has been archived, use the built-in input prompt in Enquirer instead.

License

Notifications You must be signed in to change notification settings

enquirer/prompt-input

Repository files navigation

prompt-input NPM version NPM monthly downloads NPM total downloads Linux Build Status Windows Build Status

Basic text input prompt. This can be used standalone, but it's also included in enquirer by default.

prompt-input example

Install

Install with npm:

$ npm install --save prompt-input

Usage

var Input = require('prompt-input');
var input = new Input({
  name: 'first',
  message: 'What is your name?'
});

// async
input.ask(function(answers) {
  console.log(answers);
});

// promise
input.run()
  .then(function(answers) {
    console.log(answers);
  });

Enquirer usage

There is no need to register this with enquirer, as this is the only prompt type included in enquirer by default.

About

Related projects

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

License

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


This file was generated by verb-generate-readme, v0.6.0, on September 10, 2017.