https://github.com/yaodingyd/inquirer-autosubmit-prompt
Auto submit prompt for Inquirer.js, saving one extra enter
https://github.com/yaodingyd/inquirer-autosubmit-prompt
Last synced: 12 months ago
JSON representation
Auto submit prompt for Inquirer.js, saving one extra enter
- Host: GitHub
- URL: https://github.com/yaodingyd/inquirer-autosubmit-prompt
- Owner: yaodingyd
- License: mit
- Created: 2019-01-04T20:54:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-30T20:25:12.000Z (over 6 years ago)
- Last Synced: 2025-06-19T19:57:05.770Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 7.81 KB
- Stars: 6
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# inquirer-autosubmit-prompt
## Installation
```
npm install --save inquirer-autosubmit-prompt
```
## Usage
It extends Inquire.js's default `input` and `password` with auto submit.
```javascript
inquirer.registerPrompt('autosubmit', require('inquirer-autosubmit-prompt'));
inquirer.prompt({
type: 'autosubmit',
...
})
```
### Options
See [inquirer](https://github.com/SBoudrias/Inquirer.js) readme for meaning of all except **autoSubmit** and **secret**.
**secret** indicates this is a `password` prompt. Defaults to false (`input` prompt).
**autoSubmit** should be a function which takes the current input and returns a boolean. If condition is true, current input will be submitted, without user typing enter.
### Example
```javascript
const inquirer = require('inquirer');
inquirer.registerPrompt('autosubmit', require('inquirer-autosubmit-prompt'));
const questions = [
{
type: 'autosubmit',
name: 'first_name',
message: 'What\'s your first name',
autoSubmit: input => input.length === 6
}
];
inquirer.prompt(questions).then(answers => {
console.log(JSON.stringify(answers, null, ' '));
});
```
## Credits
[Yao Ding](https://github.com/yaodingyd/)
## License
MIT