input-shell 1.0.1 → 1.3.0

package/README.md

@@ -1,9 +1,30 @@
 # input-shell
-python like `input` function using input-shell in nodejs
+python like `input` function using `input-shell` in nodejs
+
+
+---
+
+#### EXPORTED FUNCTIONS: 
+
+The asynchronous callback versions and promise versions of `input`, `inputSelect`, `inputSelectMultiple`:
+
+- `input` : input(text: string)
+- `inputAsync` : inputAsync(text: string, callback: function)
+- `inputSelect` : inputSelect(questionText: string, options: string, type: string)
+- `inputSelectAsync` : inputSelectAsync(questionText : string, options: string, type: string, callback: function)
+- `inputSelectMultipleAsync` : inputSelectMultipleAsync(questions: string, finalCallback: function)
+- `inputSelectMultiple` : inputSelectMultiple(questions: string)
+
+
+---
+
+#### DEMOS: 
+
+##### 1. input
 
 ```
 
-var { input } = require(input-shell);
+var { input } = require("input-shell");
 
 // Example usage:
 input("Input Text: ")
@@ -19,13 +40,30 @@ input("Input Text: ")
 
 ```
 
+##### 2. inputAsync
+
+```
+
+var { inputAsync } = require("input-shell");
+
+inputAsync("Enter some text: ", (err, result) => {
+    if (err) {
+        console.error("Error:", err);
+    } else {
+        console.log("Input:", result.toString());
+    }
+});
 
 ```
 
-var { inputSelect } = require(input-shell);
+##### 3. inputSelectAsync checkbox
+
+```
+
+var { inputSelectAsync } = require("input-shell");
 
 // Example usage: checkboxes
-inputSelect(
+inputSelectAsync(
     'Which fruits do you like? (Use space to select, enter to finish)',
     ['Apple', 'Banana', 'Orange', 'Grape'],
     'checkbox',
@@ -36,12 +74,14 @@ inputSelect(
 
 ```
 
+##### 4. inputSelectAsync radio
+
 ```
 
-var { inputSelect } = require(input-shell);
+var { inputSelectAsync } = require("input-shell");
 
 // Example usage: radio button
-inputSelect(
+inputSelectAsync(
     'What is your favorite color?',
     ['Red', 'Blue', 'Green', 'Yellow'],
     'radio',
@@ -52,9 +92,41 @@ inputSelect(
 
 ```
 
+##### 5. inputSelect checkbox
+
+```
+
+var { inputSelect } = require("input-shell");
+
+// Example usage: checkboxes
+inputSelect(
+    'Select multiple options:',
+    ['Checkbox A', 'Checkbox B', 'Checkbox C', 'Checkbox D'],
+    'checkbox'
+).then(e => console.log(e))
+
 ```
 
-var { inputSelectMultiple } = require(input-shell);
+##### 6. inputSelect radio
+
+```
+
+var { inputSelect } = require("input-shell");
+
+// Example usage: radio button
+inputSelect(
+    'Choose an option:',
+    ['Option 1', 'Option 2', 'Option 3'],
+    'radio'
+).then(e => console.log(e))
+
+```
+
+##### 7. inputSelectMultipleAsync
+
+```
+
+var { inputSelectMultipleAsync } = require("input-shell");
 
 // Example usage: Multiple questions with Radio, Checkbox, and Text answers
 const questions = [
@@ -64,12 +136,44 @@ const questions = [
   { text: 'What is your age?', type: 'text' },
 ];
 
-inputSelectMultiple(questions, (results) => {
-  console.log('Results:', results);
+inputSelectMultipleAsync(questions, (err, results) => {
+  if (err) {
+    console.error('Error:', err);
+    process.exit(1);
+  } else {
+    console.clear();
+    console.log('Answers:');
+    <!-- results.forEach((result) => {
+      console.log(`${result.question}: ${Array.isArray(result.answer) ? result.answer.join(', ') : result.answer}`);
+    }); -->
+    console.log("results: ", results);
+    process.exit();
+  }
 });
 
 ```
 
+##### 8. inputSelectMultipleAsync
+
+```
+
+var { inputSelectMultiple } = require("input-shell");
+
+// Example usage:
+const questions = [
+  { text: 'What is your name?', type: 'text' },
+  { text: 'What is your favorite color?', type: 'radio', options: ['Red', 'Blue', 'Green'] },
+  { text: 'Which fruits do you like?', type: 'checkbox', options: ['Apple', 'Banana', 'Orange', 'Grape'] },
+  { text: 'What is your age?', type: 'text' },
+];
+
+inputSelectMultiple(questions).then((results) => {
+  console.log('Results:', results);
+}).catch((error) => {
+  console.log('Error:', error);
+});
+
+```
 
 #### TESTS
 

package/demos/demos.input.async.js

@@ -0,0 +1,28 @@
+/**
+ * 
+ * Package: 
+ * Author: Ganesh B
+ * Description: 
+ * Install: npm i input-shell --save
+ * Github: https://github.com/ganeshkbhat/
+ * npmjs Link: https://www.npmjs.com/package/
+ * File: index.js
+ * File Description: 
+ * 
+ * 
+*/
+
+/* eslint no-console: 0 */
+
+'use strict';
+
+var { inputAsync } = require("../index");
+
+inputAsync("Enter some text: ", (err, result) => {
+    if (err) {
+        console.error("Error:", err);
+    } else {
+        console.log("Input:", result.toString());
+    }
+});
+

package/demos/demos.input.js

@@ -3,7 +3,7 @@
  * Package: 
  * Author: Ganesh B
  * Description: 
- * Install: npm i input --save
+ * Install: npm i input-shell --save
  * Github: https://github.com/ganeshkbhat/
  * npmjs Link: https://www.npmjs.com/package/
  * File: index.js

package/demos/demos.input.select.checkbox.async.js

@@ -0,0 +1,30 @@
+/**
+ * 
+ * Package: 
+ * Author: Ganesh B
+ * Description: 
+ * Install: npm i input-shell --save
+ * Github: https://github.com/ganeshkbhat/
+ * npmjs Link: https://www.npmjs.com/package/
+ * File: index.js
+ * File Description: 
+ * 
+ * 
+*/
+
+/* eslint no-console: 0 */
+
+'use strict';
+
+var { inputSelectAsync } = require("../index");
+
+// Example usage: checkboxes
+inputSelectAsync(
+    'Which fruits do you like? (Use space to select, enter to finish)',
+    ['Apple', 'Banana', 'Orange', 'Grape'],
+    'checkbox',
+    (selections) => {
+        console.log('You selected:', selections);
+    }
+);
+

package/demos/demos.input.select.checkbox.js

@@ -3,7 +3,7 @@
  * Package: 
  * Author: Ganesh B
  * Description: 
- * Install: npm i input --save
+ * Install: npm i input-shell --save
  * Github: https://github.com/ganeshkbhat/
  * npmjs Link: https://www.npmjs.com/package/
  * File: index.js
@@ -20,11 +20,7 @@ var { inputSelect } = require("../index");
 
 // Example usage: checkboxes
 inputSelect(
-    'Which fruits do you like? (Use space to select, enter to finish)',
-    ['Apple', 'Banana', 'Orange', 'Grape'],
-    'checkbox',
-    (selections) => {
-        console.log('You selected:', selections);
-    }
-);
-
+    'Select multiple options:',
+    ['Checkbox A', 'Checkbox B', 'Checkbox C', 'Checkbox D'],
+    'checkbox'
+).then(e => console.log(e))

package/demos/demos.input.select.multiple.questions.async.js

@@ -0,0 +1,42 @@
+/**
+ * 
+ * Package: 
+ * Author: Ganesh B
+ * Description: 
+ * Install: npm i input-shell --save
+ * Github: https://github.com/ganeshkbhat/
+ * npmjs Link: https://www.npmjs.com/package/
+ * File: index.js
+ * File Description: 
+ * 
+ * 
+*/
+
+/* eslint no-console: 0 */
+
+'use strict';
+
+var { inputSelectMultipleAsync } = require("../index");
+
+// Example usage:
+const questions = [
+  { text: 'What is your name?', type: 'text' },
+  { text: 'What is your favorite color?', type: 'radio', options: ['Red', 'Blue', 'Green'] },
+  { text: 'Which fruits do you like?', type: 'checkbox', options: ['Apple', 'Banana', 'Orange', 'Grape'] },
+  { text: 'What is your age?', type: 'text' },
+];
+
+inputSelectMultipleAsync(questions, (err, results) => {
+  if (err) {
+    console.error('Error:', err);
+    process.exit(1);
+  } else {
+    console.clear();
+    console.log('Answers:');
+    results.forEach((result) => {
+      console.log(`${result.question}: ${Array.isArray(result.answer) ? result.answer.join(', ') : result.answer}`);
+    });
+    console.log("results: ", results);
+    process.exit();
+  }
+});

package/demos/demos.input.select.multiple.questions.js

@@ -3,7 +3,7 @@
  * Package: 
  * Author: Ganesh B
  * Description: 
- * Install: npm i input --save
+ * Install: npm i input-shell --save
  * Github: https://github.com/ganeshkbhat/
  * npmjs Link: https://www.npmjs.com/package/
  * File: index.js
@@ -23,9 +23,33 @@ const questions = [
   { text: 'What is your name?', type: 'text' },
   { text: 'What is your favorite color?', type: 'radio', options: ['Red', 'Blue', 'Green'] },
   { text: 'Which fruits do you like?', type: 'checkbox', options: ['Apple', 'Banana', 'Orange', 'Grape'] },
+  { type: 'radio', text: 'Choose your operating system:', options: ['Windows', 'macOS', 'Linux'] },
   { text: 'What is your age?', type: 'text' },
+  { type: 'text', text: 'Enter your city?' },
 ];
 
-inputSelectMultiple(questions, (results) => {
+inputSelectMultiple(questions).then((results) => {
   console.log('Results:', results);
-});
+}).catch((error) => {
+  console.log('Error:', error);
+});
+
+// // USAGE Two: 
+// inputSelectMultiple(questions)
+//     .then((results) => {
+//         console.clear();
+//         console.log('Answers:');
+//         results.forEach((result) => {
+//             console.log(`${result.question}: ${Array.isArray(result.answer) ? result.answer.join(', ') : result.answer}`);
+//         });
+//         process.exit();
+//     })
+//     .catch((error) => {
+//         console.error('Error:', error);
+//         process.exit(1);
+//     });
+
+
+
+
+

package/demos/demos.input.select.radio.async.js

@@ -0,0 +1,29 @@
+/**
+ * 
+ * Package: 
+ * Author: Ganesh B
+ * Description: 
+ * Install: npm i input-shell --save
+ * Github: https://github.com/ganeshkbhat/
+ * npmjs Link: https://www.npmjs.com/package/
+ * File: index.js
+ * File Description: 
+ * 
+ * 
+*/
+
+/* eslint no-console: 0 */
+
+'use strict';
+
+var { inputSelectAsync } = require("../index");
+
+// Example usage: radio button
+inputSelectAsync(
+    'What is your favorite color?',
+    ['Red', 'Blue', 'Green', 'Yellow'],
+    'radio',
+    (selection) => {
+        console.log('You selected:', selection);
+    }
+);

package/demos/demos.input.select.radio.js

@@ -3,7 +3,7 @@
  * Package: 
  * Author: Ganesh B
  * Description: 
- * Install: npm i input --save
+ * Install: npm i input-shell --save
  * Github: https://github.com/ganeshkbhat/
  * npmjs Link: https://www.npmjs.com/package/
  * File: index.js
@@ -19,13 +19,10 @@
 var { inputSelect } = require("../index");
 
 // Example usage: radio button
-inputSelect(
-    'What is your favorite color?',
-    ['Red', 'Blue', 'Green', 'Yellow'],
-    'radio',
-    (selection) => {
-        console.log('You selected:', selection);
-    }
-);
 
+inputSelect(
+    'Choose an option:',
+    ['Option 1', 'Option 2', 'Option 3'],
+    'radio'
+).then(e => console.log(e))