prompt-async

The enhanced prompt module that enables you to await its methods.

Example ^{Try it now!}

With prompt-async

1const prompt = require("prompt-async");
2
3async function example_async() // Available only with `prompt-async`!
4{
5	// Start the prompt.
6	prompt.start();
7
8	// Get two properties from the user: the `username` and `email`.
9	const {username, email} = await prompt.get(["username", "email"]);
10	// Get two properties from the user: the `password` and `food`.
11	const {password, food} = await prompt.get(["password", "food"]);
12
13	// Log the results.
14	console.log("Command-line input received: ");
15	console.log(`  username: ${username},`);
16	console.log(`  password: ${password},`);
17	console.log(`  email: ${email},`);
18	console.log(`  food: ${food}.`);
19}
20
21async function error_handling_async()
22{
23	try
24	{
25		await example_async();
26	}
27	catch(error)
28	{
29		console.error("An error occurred: ", error);
30	}
31}
32
33error_handling_async();

The obsolete way _{(causes a callback hell)}

1const prompt = require("prompt-async");
2
3function example() // Still supports the obsolete way.
4{
5	// Start the prompt.
6	prompt.start();
7
8	// Get two properties from the user: the `username` and `email`.
9	prompt.get(["username", "email"], (error, result1) => {
10		if(error)
11		{
12			throw Error(error);
13		}
14
15		// Get two properties from the user: the `password` and `food`.
16		prompt.get(["password", "food"], (error, result2) => {
17			if(error)
18			{
19				throw Error(error);
20			}
21
22			// Log the results.
23			console.log("Command-line input received: ");
24			console.log(`  username: ${result1.username},`);
25			console.log(`  password: ${result2.password},`);
26			console.log(`  email: ${result1.email},`);
27			console.log(`  food: ${result2.food}.`);
28		});
29	});
30}
31
32function error_handling()
33{
34	try
35	{
36		example();
37	}
38	catch(error)
39	{
40		console.error("An error occurred: ", error);
41	}
42}
43
44error_handling();

Frequently answered questions

I've been working with prompt. Do I have to modify the existing code to use this?

The only thing you have to do is to replace require("prompt") to require("prompt-async"). As you can see above, it has backward-compatibility, so it would work well with your prompt code. However, please be aware that your prompt code pattern is discouraged, and try to use async-await pattern.

Any bugs, suggestions, or questions?

If you found a bug on it, or if you want to suggest something to improve it, or if you have a question, please leave an issue on the GitHub repository or send an e-mail to me: wlzla000@naver.com.

Feel free to contribute!

Thank you.

Licensed under

the MIT license.