# Module: commandStringParsing

Contains all system defined business rules for parsing strings with specific focus on command string parsing.

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

### Requires

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

### Methods

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

Removes any "--" from the command to make it a valid command.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | The string that should have the "--" removed from it.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/stringParsing/commandStringParsing.js, line 27

##### Returns:

The same as the input, but with the "--" removed.

Type
  string

#### (inner) isValidCommandNameString(inputData, inputMetaData) → {boolean}

Determines if the command name is a valid command name or not.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | The string that should be evaluated if it is sufficiently formatted such that it could qualify as a command name.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/stringParsing/commandStringParsing.js, line 52

##### Returns:

True or False to indicate if the string is sufficiently formatted to be considered as a command name in the system.

Type
  boolean