# Module: promptOperations

A simple prompt module to get input from the user using process.stdin.

Author:
  - Seth Hollingsead
Copyright:
  - Copyright © 2022-… by Seth Hollingsead. All rights reserved
Source:
  - businessRules/rules/promptOperations.js, line 2

### Requires

- module:loggers
- @haystacks/constants
- fs
- path

### Methods

#### (inner) prompt(inputData, inputMetaData) → {string}

Prompts the user for some input and returns the input.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | What the prompt should display when asking the user for input.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/promptOperations.js, line 28

##### Returns:

A string of whatever input the user gave.

Type
  string

#### (inner) promptRaw(inputData, inputMetaData) → {string}

Allows for single keystroke character input from the keyboard, without pressing the enter key to confirm input.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Not used for this business rule.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/promptOperations.js, line 59

##### Returns:

The character entered by the user.

Type
  string