simple-js-input/README.md

A simple JavaScript package to get terminal input, mimicking Python's input() function.

# simple-js-input

A simple JavaScript package to get terminal input, mimicking Python's `input()` function.

## Installation

```bash
npm install simple-js-input
# or
yarn add simple-js-input
# or
pnpm install simple-js-input
# or
bun install simple-js-input
```
## Usage

Once installed, you can require the input function in your Node.js script and use it with async/await:

```js
const { input } = require('simple-js-input');

async function getUserInput() {
  const name = await input('What is your name? ');
  const age = await input('How old are you? ');
  console.log(`Hello, ${name}! You are ${age} years old.`);
}

getUserInput();

```

## API Reference

`input(promptText)`
- `promptText` (String): The string displayed to the user as a prompt before they enter input.

- Returns: `Promise<string>` - A Promise that resolves with the user's entered text as a string.

This function displays the `promptText` to the user in the terminal, waits for them to type something and press Enter, and then resolves the Promise with the entered string. It handles standard string input. Pressing Ctrl+C during the prompt will typically terminate the Node.js process.

Features
- Asynchronous Input: Returns a Promise, allowing non-blocking operations and easy integration with async/await.

- Simple API: A single input function for straightforward command-line interactions.

- Cross-Platform: Works wherever Node.js is supported.

## Contributing
Contributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request on the GitHub repository.

## License
This project is licensed under the MIT License. See the LICENSE file (if applicable) for more details.