Input-Deno

Used to get command line input from the user

Usage

import InputLoop from 'https://raw.githubusercontent.com/Yazidn/input-deno/master/install/input.ts';

// Example
const input = new InputLoop();
await input.choose(['Option 1', 'Option 2', 'Option 3', 'Option 4', 'Option 5', 'Option 6', 'Quit'], {
	lastOptionClose: true,
	displayInline: true,
	indexStyle: ['{ ', ' }'],
	dividerBottom: true,
	dividerLength: 127,
	inlineSeparator: ' | '
});

// Output

// { 0 } Option 1  |  { 1 } Option 2  |  { 2 } Option 3  |  { 3 } Option 4  |  { 4 } Option 5  |  { 5 } Option 6  |  { 6 } Quit  |  
// -------------------------------------------------------------------------------------------------------------------------------

Choose

Returns an array indicating which index was selected

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]

You can further customize the behavior of the choose method by passing an object of perferences as a second argument. All preferences are optional, as shown in the interface below.

interface Preferences {
	lastOptionClose?: boolean,
	choice?: string | number,
	displayInline?: boolean, // if true, display all options in the same line
	inlineSeparator?: string, // takes a string, e.g. '|', pipe would be set as a separator instead of spaces.
	inlineSpacing?: number, // number of spaces between inline options, default is 2 (Only works when inlineSeparator is NOT set.)
	indexStyle?: string[], // an array of 2 strings to surround the index. e.g. ['[', ']']. Can be any string
	dividerUp?: boolean, // Show a divider above the options
	dividerBottom?: boolean // Show a divider below the options
	dividerLength?: number // Set a custom length for the divider
	dividerChar?: string, // Set a custom character for the divider, default is '-'
	dividerPadding?: boolean // Add space (new line) between dividers and options. 
}

Question

Ask a single question

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:

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.

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:

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

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();
}

Testing

Deno tests can be run using:

make test