https://github.com/keegandonley/input-deno
CLI user input handler for Deno
https://github.com/keegandonley/input-deno
cli deno hacktoberfest input
Last synced: 10 months ago
JSON representation
CLI user input handler for Deno
- Host: GitHub
- URL: https://github.com/keegandonley/input-deno
- Owner: keegandonley
- License: mit
- Created: 2020-05-26T22:51:59.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-04T22:15:18.000Z (over 2 years ago)
- Last Synced: 2025-09-01T03:33:41.331Z (10 months ago)
- Topics: cli, deno, hacktoberfest, input
- Language: TypeScript
- Homepage:
- Size: 50.8 KB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: history.test.ts
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Input-Deno v2.0.4
Used to get command line input from the user
## Choose
Returns an array indicating which index was selected
```javascript
const input = new InputLoop();
const accepting = await input.choose(["Accepting node", "Non-accepting node"]);
// output:
// ------------------------------
// 0: Accepting node
// 1: Non-accepting node
// ------------------------------
// Return value:
// [false, true]
```
## Question
Ask a single question
```javascript
const input = new InputLoop();
const nodeName = await input.question('Enter the label for the node:');
// output:
// Enter the label for the node:
// Return Value:
// 'a'
```
Skip the newline after printing the question:
```javascript
const input = new InputLoop();
const nodeName = await input.question('Enter the label for the node:', false);
// output:
// Enter the label for the node:
// Return Value:
// 'a'
```
## Looping
Control an input loop which continues reprompting until terminated
#### Automatic Looping:
Passing `true` as the second argument will automatically end the iteration of the last option is selected.
```javascript
const input = new InputLoop();
const mainQuestions = ["Add a node", "Add an edge", "Set starting node", "Evaluate a string", "Quit"];
while (!input.done) {
const result = await input.choose(mainQuestions, true);
// Business logic...
}
```
#### Manual Looping:
```javascript
const input = new InputLoop();
const mainQuestions = ["Add a node", "Add an edge", "Set starting node", "Evaluate a string", "Quit"];
while (!input.done) {
const result = await input.choose(mainQuestions);
// Business logic...
if (result[mainQuestions.length - 1]) {
input.close();
}
}
```
## Repeat
Repeat the previous question
```javascript
const input = new InputLoop();
const mainQuestions = ["Add a node", "Add an edge", "Set starting node", "Evaluate a string", "Quit"];
let result = await input.choose(mainQuestions);
while (!(result[0] || result[1])) {
result = input.repeat();
}
```
## Experimental
In order to use private input (not visible as you type), use the `--unstable` flag when running, and you can pass a flag to `choose` or `question` to enable it:
```javascript
const input = new InputLoop();
const mainQuestions = ["Add a node", "Add an edge", "Set starting node", "Evaluate a string", "Quit"];
let result = await input.choose(mainQuestions, false, true);
while (!(result[0] || result[1])) {
result = input.repeat();
}
```
This is also required for `input.wait()`, which can be used to wait for any key to be pressed:
```javascript
await input.wait('Press any key to continue...', true);
// Equivalent to
await input.wait();
```
## Testing
Deno tests can be run using:
```
make test
```