Inquirer.js
Inquirer.js copied to clipboard
SBoudrias
The default value with timeout
Could we provide the countdown for default value?
If user didn't pick one value before timeout, like in 5s, it will automatically pick the default value and move to next step.
Could we support such feature?
Should be very useful in many scenarios with default value and this won't let people wait for too long time before they realized they have to pick one option.
I like this would be a feature.
It would be nice to skip stop or fill a question on a external event. For example a timebased multiple choise quiz.
I can't find a option to skip it, without user input
Simply put the prompt in a Promise and use a normal setTimeout:
async function timeoutPrompt(question, defaultAnswer, timeMs) {
return await new Promise(async (resolve) => {
let options = {
name: 'yourKey',
message: question,
};
setTimeout(function () {
resolve(defaultAnswer);
}, timeMs);
let answer = await Inquirer.prompt([options]);
resolve(answer);
});
}
(async () => {
let answer = await timeoutPrompt('Can you wait 5 seconds please', 'no', 4999);
console.table(answer);
})();
If you want to use a callback, simply replace resolve by your callback function.
@SBoudrias could you add this, this is simple and very useful base functionality. Thanks a lot!
TBH, I think it's easy enough to wrap a setTimeout on the developers' side. It's not necessary to make this a base functionality.
The whole point of theese brilliant libraries, that they do make it easy for developers to implement things in a given area of coding, something that's repeated millions of times. Yes, this can be done on the developer's side, but I guess most will just look for another library that has this built in or do some hackish solution or fail. Actually whatever this module does can be done by developers, so why does it even exist? It's a balance.
A good project should be simple and easy to use for everyone.
Take this Timeout feature as an example, we need to think about:
- When the user sends keyboard events, which events will refresh the countdown?
- In which scenarios will this function be needed?
- What are the benefits of being built-in? Why not make it a plugin?
- What other products have a countdown at the CLI prompt?
- How to test this?
We can keep this issue open and let's see how many users want this.
@SBoudrias I just realize we now have no way to manually end the current prompt.
Previously we can use prompt.ui.activePrompt.done() to set the prompt to done. But for our @inquirer/prompts, we don't have an API like that.
@andrisi For the old inquirer, you can use Promise.race to implement this feature.
const prompt = inquirer.prompt(...);
const defaultValue = new Promise(resolve => {
setTimeout(() => {
resolve(...)
prompt.ui.activePrompt.done();
}, 5000);
});
const answers = await Promise.race([defaultValue, prompt])
This is easy enough.
We can change the documentation to await setTimeout() once we target our package with Node.js 16.
See https://nodejs.org/api/timers.html#timerspromisessettimeoutdelay-value-options
@LitoMore want to send a PR to do this now? In the documention, it's fine to target new Node; especially in recipes!
@SBoudrias np. But we have already released a new major version of our package.
The "engines": ">=16" change will be another breaking to our package.
What do you think? Or just ignore this since we don't have too much users right now?
Oh, I don't mean we should bump require v16 today. I meant that the recipes can refer to timers/promises even if it won't work for Node 14 users.