rbezkrylyiinteractive
v1.0.1
Published
Create a package that allows developers to easily build interactive command-line interfaces for their Node.js applications. This could include features like customizable prompts, validation, and user-friendly error handling
Downloads
4
Maintainers
Readme
Interactive CLI Toolkit
A simple JavaScript package for building interactive command-line interfaces (CLI) in Node.js.
Installation
You can install the package via npm:
npm install interactive-cli-toolkit
Usage
const InteractiveCLI = require('interactive-cli-toolkit');
// Create a new instance of the InteractiveCLI class
const cli = new InteractiveCLI();
// Ask a question and wait for user input
async function main() {
const name = await cli.ask('What is your name?');
console.log(`Hello, ${name}!`);
cli.close();
}
main();
Methods
ask(question: string): Promise<string>
Prompts the user with a question and returns their input.
askWithOptions(question: string, options: string[]): Promise<string>
Prompts the user with a question and a set of options, ensuring that the user's input matches one of the provided options.
close(): void
Closes the readline interface.
Example
const InteractiveCLI = require('interactive-cli-toolkit');
const cli = new InteractiveCLI();
async function main() {
const favoriteColor = await cli.askWithOptions('What is your favorite color?', ['Red', 'Green', 'Blue']);
console.log(`Your favorite color is ${favoriteColor}!`);
cli.close();
}
main();
License
This package is open source and available under the MIT License.#� �r�b�e�z�k�r�y�l�y�i�-�I�n�t�e�r�a�c�t�i�v�e�-�C�L�I�-�T�o�o�l�k�i�t� � �