# Module: pathArrayParsing

Contains all system defined business rules for parsing arrays specific to paths.

Author:
  - Seth Hollingsead
Copyright:
  - Copyright © 2021-… by Seth Hollingsead. All rights reserved
Source:
  - businessRules/rules/arrayParsing/pathArrayParsing.js, line 1

### Requires

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

### Methods

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

Checks if an array contains a filename, after stripping off the path.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | array.<string> | The array of file names that should be checked for the input file name we are looking for.
`inputMetaData` | string | The file name we are looking for in the input array.

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

##### Returns:

A True or False value to indicate if the file name was found or not.

Type
  boolean

#### (inner) getFileAndPathListForPath(inputData, inputMetaData) → {array.<string>}

Scans all files and folders recursively given an input path and returns a list of all files and their full paths found under the specified input path.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | The path that should be scanned for files and their full paths.
`inputMetaData` | integer | Optional file limit, ignored if the configuration flag is not set to true, if nothing is passed the configuration setting will be used.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/arrayParsing/pathArrayParsing.js, line 62

##### Returns:

The array that contains the full path and file name for every file found under the specified path.

Type
  array.<string>