Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enquirer/prompt-input
This repository has been archived, use the built-in input prompt in Enquirer instead.
https://github.com/enquirer/prompt-input
ask command-line enquirer input prompt question terminal text
Last synced: 6 days ago
JSON representation
This repository has been archived, use the built-in input prompt in Enquirer instead.
- Host: GitHub
- URL: https://github.com/enquirer/prompt-input
- Owner: enquirer
- License: mit
- Created: 2016-08-29T01:14:24.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-10T23:17:16.000Z (about 7 years ago)
- Last Synced: 2024-10-28T14:54:59.751Z (23 days ago)
- Topics: ask, command-line, enquirer, input, prompt, question, terminal, text
- Language: JavaScript
- Homepage: https://github.com/enquirer/enquirer
- Size: 646 KB
- Stars: 7
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# prompt-input [](https://www.npmjs.com/package/prompt-input) [](https://npmjs.org/package/prompt-input) [](https://npmjs.org/package/prompt-input) [](https://travis-ci.org/enquirer/prompt-input) [](https://ci.appveyor.com/project/enquirer/prompt-input)
> Basic text input prompt. This can be used standalone, but it's also included in [enquirer] by default.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save prompt-input
```
## Usage
```js
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
- [enquirer](https://www.npmjs.com/package/enquirer): Intuitive, plugin-based prompt system for node.js. | [homepage](http://enquirer.io "Intuitive, plugin-based prompt system for node.js.")
- [prompt-base](https://www.npmjs.com/package/prompt-base): Base prompt module used for creating custom prompts. | [homepage](https://github.com/enquirer/prompt-base "Base prompt module used for creating custom prompts.")
- [prompt-checkbox](https://www.npmjs.com/package/prompt-checkbox): Multiple-choice/checkbox prompt. Can be used standalone or with a prompt system like [Enquirer]. | [homepage](https://github.com/enquirer/prompt-checkbox "Multiple-choice/checkbox prompt. Can be used standalone or with a prompt system like [Enquirer].")
- [prompt-confirm](https://www.npmjs.com/package/prompt-confirm): Confirm (yes/no) prompt. Can be used standalone or with a prompt system like [Enquirer]. | [homepage](https://github.com/enquirer/prompt-confirm "Confirm (yes/no) prompt. Can be used standalone or with a prompt system like [Enquirer].")
- [prompt-input](https://www.npmjs.com/package/prompt-input): Basic text input prompt. This can be used standalone, but it's also included in [enquirer… [more](https://github.com/enquirer/prompt-input) | [homepage](https://github.com/enquirer/prompt-input "Basic text input prompt. This can be used standalone, but it's also included in [enquirer] by default.")
- [prompt-list](https://www.npmjs.com/package/prompt-list): List-style prompt. Can be used as a standalone prompt, or with a prompt system like… [more](https://github.com/enquirer/prompt-list) | [homepage](https://github.com/enquirer/prompt-list "List-style prompt. Can be used as a standalone prompt, or with a prompt system like [enquirer].")
- [prompt-sort](https://www.npmjs.com/package/prompt-sort): Prompt that allows the user to re-order items in a list of choices. | [homepage](https://github.com/enquirer/prompt-sort "Prompt that allows the user to re-order items in a list of choices.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### 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:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 10, 2017._
[enquirer]: http://enquirer.io