si-funciona 1.0.0

package/README.md

@@ -0,0 +1,1127 @@
-1 to indicate val1 is less than val2
-1 to indicate val1 is less than val2
+# Sí, funciona
+
+## Funciones de utilidad para uso general. [General usage utility functions.]
+
+## Modules
+
+<dl>
+<dt><a href="#module_siFunciona">siFunciona</a></dt>
+<dd><p>All of the siFunciona system functions for stringing together functions and simplifying logic.</p>
+</dd>
+<dt><a href="#module_stringHelpers">stringHelpers</a></dt>
+<dd><p>Manage how strings are manipulated with these utilities.</p>
+</dd>
+<dt><a href="#module_objectHelpers">objectHelpers</a></dt>
+<dd><p>Simplify working with object by providing array-like parsing. Also, provides cloning and merging along with accessors that always have a return value for optimal nesting.</p>
+</dd>
+<dt><a href="#module_numberHelpers">numberHelpers</a></dt>
+<dd><p>Some number comparators and random number generators.</p>
+</dd>
+<dt><a href="#module_functionHelpers">functionHelpers</a></dt>
+<dd><p>Manage how functions are called with these utilities.</p>
+</dd>
+<dt><a href="#module_objectDescriptors">objectDescriptors</a></dt>
+<dd><p>Create a format to standardize every object into a specific template.</p>
+</dd>
+<dt><a href="#module_arrayHelpers">arrayHelpers</a></dt>
+<dd><p>Some simple utility functions for generating arrays or performing work on arrays.</p>
+</dd>
+</dl>
+
+<a name="module_siFunciona"></a>
+
+## siFunciona
+All of the siFunciona system functions for stringing together functions and simplifying logic.
+
+**Version**: 1.0.0  
+**Author**: Joshua Heagle <joshuaheagle@gmail.com>  
+<a name="module_stringHelpers"></a>
+
+## stringHelpers
+Manage how strings are manipulated with these utilities.
+
+**Version**: 1.0.0  
+**Author**: Joshua Heagle <joshuaheagle@gmail.com>  
+
+* [stringHelpers](#module_stringHelpers)
+    * [.words(str)](#module_stringHelpers.words) ⇒ <code>array</code>
+    * [.ucFirst(str)](#module_stringHelpers.ucFirst) ⇒ <code>string</code>
+    * [.titleCase(str)](#module_stringHelpers.titleCase) ⇒ <code>string</code>
+    * [.snakeCase(str)](#module_stringHelpers.snakeCase) ⇒ <code>string</code>
+    * [.kabobCase(str)](#module_stringHelpers.kabobCase) ⇒ <code>string</code>
+    * [.camelCase(str)](#module_stringHelpers.camelCase) ⇒ <code>string</code>
+
+<a name="module_stringHelpers.words"></a>
+
+### stringHelpers.words(str) ⇒ <code>array</code>
+Split a string into sets of numbers or letters.
+
+**Kind**: static method of [<code>stringHelpers</code>](#module_stringHelpers)  
+
+| Param | Type |
+| --- | --- |
+| str | <code>string</code> | 
+
+<a name="module_stringHelpers.ucFirst"></a>
+
+### stringHelpers.ucFirst(str) ⇒ <code>string</code>
+Given a string, make the first character uppercase and the rest lowercase.
+
+**Kind**: static method of [<code>stringHelpers</code>](#module_stringHelpers)  
+
+| Param | Type |
+| --- | --- |
+| str | <code>string</code> | 
+
+<a name="module_stringHelpers.titleCase"></a>
+
+### stringHelpers.titleCase(str) ⇒ <code>string</code>
+Given a string in kebab-case, snake_case, camelCase or 'Sentence case', convert to 'Title Case'.
+
+**Kind**: static method of [<code>stringHelpers</code>](#module_stringHelpers)  
+
+| Param | Type |
+| --- | --- |
+| str | <code>string</code> | 
+
+<a name="module_stringHelpers.snakeCase"></a>
+
+### stringHelpers.snakeCase(str) ⇒ <code>string</code>
+Given a string in kebab-case, camelCase or 'Sentence case', convert to snake_case.
+
+**Kind**: static method of [<code>stringHelpers</code>](#module_stringHelpers)  
+
+| Param | Type |
+| --- | --- |
+| str | <code>string</code> | 
+
+<a name="module_stringHelpers.kabobCase"></a>
+
+### stringHelpers.kabobCase(str) ⇒ <code>string</code>
+Given a string in snake_case, camelCase or 'Sentence case', convert to kabob-case.
+
+**Kind**: static method of [<code>stringHelpers</code>](#module_stringHelpers)  
+
+| Param | Type |
+| --- | --- |
+| str | <code>string</code> | 
+
+<a name="module_stringHelpers.camelCase"></a>
+
+### stringHelpers.camelCase(str) ⇒ <code>string</code>
+Given a string in kebab-case, snake_case or 'Sentence case', convert to camelCase.
+
+**Kind**: static method of [<code>stringHelpers</code>](#module_stringHelpers)  
+
+| Param | Type |
+| --- | --- |
+| str | <code>string</code> | 
+
+<a name="module_objectHelpers"></a>
+
+## objectHelpers
+Simplify working with object by providing array-like parsing. Also, provides cloning and merging along with accessors that always have a return value for optimal nesting.
+
+**Version**: 1.0.0  
+**Author**: Joshua Heagle <joshuaheagle@gmail.com>  
+
+* [objectHelpers](#module_objectHelpers)
+    * _static_
+        * [.setValue(key, value, item)](#module_objectHelpers.setValue) ⇒ <code>Object</code> \| <code>Array</code>
+        * [.setAndReturnValue(item, key, value)](#module_objectHelpers.setAndReturnValue) ⇒ <code>\*</code>
+        * [.reduceObject(obj, fn, [initialValue])](#module_objectHelpers.reduceObject) ⇒ <code>Object</code> \| <code>Array</code>
+        * [.objectValues(object, [includeInherited])](#module_objectHelpers.objectValues) ⇒ <code>Array</code>
+        * [.objectKeys(object, [includeInherited])](#module_objectHelpers.objectKeys) ⇒ <code>Array.&lt;(string\|number)&gt;</code>
+        * [.mergeObjectsMutable(...objects)](#module_objectHelpers.mergeObjectsMutable) ⇒ <code>\*</code>
+        * [.mergeObjectsBase([options])](#module_objectHelpers.mergeObjectsBase) ⇒ [<code>mergeObjectsCallback</code>](#module_objectHelpers..mergeObjectsCallback)
+        * [.mergeObjects(...objects)](#module_objectHelpers.mergeObjects) ⇒ <code>\*</code>
+        * [.mapObject(obj, fn, [thisArg])](#module_objectHelpers.mapObject) ⇒ <code>Object</code> \| <code>Array</code>
+        * [.isObject(object)](#module_objectHelpers.isObject) ⇒ <code>boolean</code>
+        * [.isInstanceObject(object)](#module_objectHelpers.isInstanceObject) ⇒ <code>boolean</code>
+        * [.isCloneable(value)](#module_objectHelpers.isCloneable) ⇒ <code>boolean</code>
+        * [.filterObject(obj, fn, [thisArg])](#module_objectHelpers.filterObject) ⇒ <code>Object</code> \| <code>Array</code>
+        * [.emptyObject(item)](#module_objectHelpers.emptyObject) ⇒ <code>boolean</code>
+        * [.dotUnset(arrayObject, dotNotation)](#module_objectHelpers.dotUnset) ⇒ <code>Object</code>
+        * [.dotSet(arrayObject, dotNotation, value)](#module_objectHelpers.dotSet) ⇒ <code>Object</code>
+        * [.dotNotate(arrayObject, [retainObjects])](#module_objectHelpers.dotNotate) ⇒ <code>DotNotatedObject</code>
+        * [.dotGet(arrayObject, dotNotation, [defaultValue])](#module_objectHelpers.dotGet) ⇒ <code>\*</code>
+        * [.cloneObject(object, [options])](#module_objectHelpers.cloneObject) ⇒ <code>Object</code>
+        * [.DotNotationString](#module_objectHelpers.DotNotationString) : <code>string</code>
+        * [.DotNotatedObject](#module_objectHelpers.DotNotatedObject) : <code>Object.&lt;DotNotationString, \*&gt;</code>
+    * _inner_
+        * [~handleRetainObjects([retainObjects])](#module_objectHelpers..handleRetainObjects) ⇒ <code>function</code>
+        * [~performDotNotate(arrayObject, didRetain, [prepend], [results])](#module_objectHelpers..performDotNotate) ⇒ <code>DotNotatedObject</code>
+        * [~reduceCallback](#module_objectHelpers..reduceCallback) ⇒ <code>\*</code>
+        * [~mergeObjectsCallback](#module_objectHelpers..mergeObjectsCallback) ⇒ <code>\*</code>
+        * [~mapCallback](#module_objectHelpers..mapCallback) ⇒ <code>\*</code>
+        * [~filterCallback](#module_objectHelpers..filterCallback) ⇒ <code>boolean</code>
+
+<a name="module_objectHelpers.setValue"></a>
+
+### objectHelpers.setValue(key, value, item) ⇒ <code>Object</code> \| <code>Array</code>
+Set a value on an item, then return the item.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| key | <code>string</code> \| <code>number</code> | The key on the item which will have its value set |
+| value | <code>\*</code> | Any value to be applied to the key |
+| item | <code>Object</code> \| <code>Array</code> | An object or array to be updated |
+
+<a name="module_objectHelpers.setAndReturnValue"></a>
+
+### objectHelpers.setAndReturnValue(item, key, value) ⇒ <code>\*</code>
+Set a value on an item, then return the value
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| item | <code>Object</code> \| <code>Array</code> | An object or array to be updated |
+| key | <code>string</code> \| <code>number</code> | The key on the item which will have its value set |
+| value | <code>\*</code> | Any value to be applied to the key |
+
+<a name="module_objectHelpers.reduceObject"></a>
+
+### objectHelpers.reduceObject(obj, fn, [initialValue]) ⇒ <code>Object</code> \| <code>Array</code>
+This function is intended to replicate behaviour of the Array.reduce() function but for Objects.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| obj | <code>Object</code> \| <code>Array</code> | The Object (or Array) to be filtered |
+| fn | [<code>reduceCallback</code>](#module_objectHelpers..reduceCallback) \| <code>function</code> | The function to be processed for each filtered property |
+| [initialValue] | <code>Object</code> \| <code>Array</code> | Optional. Value to use as the first argument to the first call of the callback. If no initial value is supplied, the first element in the array will be used. Calling reduce on an empty array without an initial value is an error. |
+
+<a name="module_objectHelpers.objectValues"></a>
+
+### objectHelpers.objectValues(object, [includeInherited]) ⇒ <code>Array</code>
+Get an array of values from any object or array. Will return empty array when invalid or there are no values.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| object | <code>Object</code> \| <code>Array</code> |  | 
+| [includeInherited] | <code>boolean</code> | <code>false</code> | 
+
+<a name="module_objectHelpers.objectKeys"></a>
+
+### objectHelpers.objectKeys(object, [includeInherited]) ⇒ <code>Array.&lt;(string\|number)&gt;</code>
+Get an array of keys from any object or array. Will return empty array when invalid or there are no keys.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| object | <code>Object</code> \| <code>Array</code> |  | 
+| [includeInherited] | <code>boolean</code> | <code>false</code> | 
+
+<a name="module_objectHelpers.mergeObjectsMutable"></a>
+
+### objectHelpers.mergeObjectsMutable(...objects) ⇒ <code>\*</code>
+Uses mergeObjectsBase deep merge objects and arrays, merge by reference.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+**See**: [mergeObjectsCallback](#module_objectHelpers..mergeObjectsCallback)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ...objects | <code>Object</code> | Provide a list of objects which will be merged starting from the end up into the first |
+
+<a name="module_objectHelpers.mergeObjectsBase"></a>
+
+### objectHelpers.mergeObjectsBase([options]) ⇒ [<code>mergeObjectsCallback</code>](#module_objectHelpers..mergeObjectsCallback)
+Perform a deep merge of objects. This will return a function that will combine all objects and sub-objects.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| [options] | <code>Object</code> | <code>{}</code> | 
+| [options.mapLimit] | <code>number</code> | <code>1000</code> | 
+| [options.depthLimit] | <code>number</code> | <code>-1</code> | 
+| [options.relevancyRange] | <code>number</code> | <code>100</code> | 
+| [options.map] | <code>Iterable</code> \| <code>array</code> | <code>[]</code> | 
+| [options.useClone] | <code>boolean</code> | <code>false</code> | 
+
+<a name="module_objectHelpers.mergeObjects"></a>
+
+### objectHelpers.mergeObjects(...objects) ⇒ <code>\*</code>
+Uses mergeObjectsBase deep merge objects and arrays, merge by value.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+**See**: [mergeObjectsCallback](#module_objectHelpers..mergeObjectsCallback)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ...objects | <code>Object</code> | Provide a list of objects which will be merged starting from the end up into the first |
+
+<a name="module_objectHelpers.mapObject"></a>
+
+### objectHelpers.mapObject(obj, fn, [thisArg]) ⇒ <code>Object</code> \| <code>Array</code>
+This function is intended to replicate behaviour of the Array.map() function but for Objects.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| obj | <code>Object</code> \| <code>Array</code> | The Object (or Array) to be mapped |
+| fn | [<code>mapCallback</code>](#module_objectHelpers..mapCallback) \| <code>function</code> | The function to be processed for each mapped property |
+| [thisArg] | <code>Object</code> \| <code>Array</code> | Optional. Value to use as this when executing callback. |
+
+<a name="module_objectHelpers.isObject"></a>
+
+### objectHelpers.isObject(object) ⇒ <code>boolean</code>
+Check if the provided thing is an object / array.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type |
+| --- | --- |
+| object | <code>\*</code> | 
+
+<a name="module_objectHelpers.isInstanceObject"></a>
+
+### objectHelpers.isInstanceObject(object) ⇒ <code>boolean</code>
+Check if the current object has inherited properties.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type |
+| --- | --- |
+| object | <code>Object</code> \| <code>Array</code> | 
+
+<a name="module_objectHelpers.isCloneable"></a>
+
+### objectHelpers.isCloneable(value) ⇒ <code>boolean</code>
+Determine if the value is a reference instance
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type |
+| --- | --- |
+| value | <code>Array</code> \| <code>Object</code> \| <code>\*</code> | 
+
+<a name="module_objectHelpers.filterObject"></a>
+
+### objectHelpers.filterObject(obj, fn, [thisArg]) ⇒ <code>Object</code> \| <code>Array</code>
+This function is intended to replicate behaviour of the Array.filter() function but for Objects.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| obj | <code>Object</code> \| <code>Array</code> | The Object (or Array) to be filtered |
+| fn | [<code>filterCallback</code>](#module_objectHelpers..filterCallback) \| <code>function</code> | The function to be processed for each filtered property |
+| [thisArg] | <code>Object</code> \| <code>Array</code> | Optional. Value to use as this when executing callback. |
+
+<a name="module_objectHelpers.emptyObject"></a>
+
+### objectHelpers.emptyObject(item) ⇒ <code>boolean</code>
+Helper function for testing if the item is an Object or Array that does not have any properties
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| item | <code>Object</code> \| <code>Array</code> | Object or Array to test |
+
+<a name="module_objectHelpers.dotUnset"></a>
+
+### objectHelpers.dotUnset(arrayObject, dotNotation) ⇒ <code>Object</code>
+Unset a nested property value an object.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+**Returns**: <code>Object</code> - The modified object  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| arrayObject | <code>Object</code> | The array or object to set the property on |
+| dotNotation | <code>string</code> | The path for the property |
+
+<a name="module_objectHelpers.dotSet"></a>
+
+### objectHelpers.dotSet(arrayObject, dotNotation, value) ⇒ <code>Object</code>
+Set a nested property value an object.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+**Returns**: <code>Object</code> - The modified object  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| arrayObject | <code>Object</code> |  | The array or object to set the property on |
+| dotNotation | <code>string</code> |  | The path for the property |
+| value | <code>\*</code> | <code></code> | The default value to return if the property is not found |
+
+<a name="module_objectHelpers.dotNotate"></a>
+
+### objectHelpers.dotNotate(arrayObject, [retainObjects]) ⇒ <code>DotNotatedObject</code>
+Convert an array or object to a single dimensional associative array with dot notation.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+**Returns**: <code>DotNotatedObject</code> - The dot-notated object  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| arrayObject | <code>Object</code> |  | The array or object to dot-notate |
+| [retainObjects] | <code>Array.&lt;DotNotationString&gt;</code> | <code>[]</code> | An array of keys to retain as objects |
+
+<a name="module_objectHelpers.dotGet"></a>
+
+### objectHelpers.dotGet(arrayObject, dotNotation, [defaultValue]) ⇒ <code>\*</code>
+Get a nested property value from an object.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+**Returns**: <code>\*</code> - The value of the property  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| arrayObject | <code>Object</code> |  | The array or object to get the property from |
+| dotNotation | <code>string</code> |  | The path to the property |
+| [defaultValue] | <code>string</code> \| <code>null</code> | <code>null</code> | The default value to return if the property is not found |
+
+<a name="module_objectHelpers.cloneObject"></a>
+
+### objectHelpers.cloneObject(object, [options]) ⇒ <code>Object</code>
+Clone objects for manipulation without data corruption, returns a copy of the provided object.
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| object | <code>Object</code> |  | The original object that is being cloned |
+| [options] | <code>Object</code> | <code>{}</code> |  |
+| [options.mapLimit] | <code>number</code> | <code>1000</code> |  |
+| [options.depthLimit] | <code>number</code> | <code>-1</code> |  |
+| [options.relevancyRange] | <code>number</code> | <code>100</code> |  |
+| [options.map] | <code>Iterable</code> | <code>[]</code> |  |
+
+<a name="module_objectHelpers.DotNotationString"></a>
+
+### objectHelpers.DotNotationString : <code>string</code>
+A string representing the full-path to a property in an object. Each depth of the path is separated by a period.
+
+**Kind**: static typedef of [<code>objectHelpers</code>](#module_objectHelpers)  
+**Example**  
+```js
+'a.b.c'
+```
+<a name="module_objectHelpers.DotNotatedObject"></a>
+
+### objectHelpers.DotNotatedObject : <code>Object.&lt;DotNotationString, \*&gt;</code>
+An array or object where all properties have been flatted and keyed by a dot-notated string.
+
+**Kind**: static typedef of [<code>objectHelpers</code>](#module_objectHelpers)  
+<a name="module_objectHelpers..handleRetainObjects"></a>
+
+### objectHelpers~handleRetainObjects([retainObjects]) ⇒ <code>function</code>
+Convert an array of keys into a regex, return a function to test if incoming keys match.
+
+**Kind**: inner method of [<code>objectHelpers</code>](#module_objectHelpers)  
+**Returns**: <code>function</code> - The dot-notated array  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [retainObjects] | <code>Array.&lt;DotNotationString&gt;</code> | <code>[]</code> | An array of keys to retain as objects |
+
+<a name="module_objectHelpers..performDotNotate"></a>
+
+### objectHelpers~performDotNotate(arrayObject, didRetain, [prepend], [results]) ⇒ <code>DotNotatedObject</code>
+The underlying logic function for converting arrays to dot-notation.
+
+**Kind**: inner method of [<code>objectHelpers</code>](#module_objectHelpers)  
+**Returns**: <code>DotNotatedObject</code> - The dot-notated object  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| arrayObject | <code>Object</code> |  | The array or object to dot-notate |
+| didRetain | <code>function</code> |  | The test function to see if a key should be retained |
+| [prepend] | <code>DotNotationString</code> | <code>&#x27;&#x27;</code> | The path for the property being processed |
+| [results] | <code>DotNotatedObject</code> | <code>{}</code> | The final array to return |
+
+<a name="module_objectHelpers..reduceCallback"></a>
+
+### objectHelpers~reduceCallback ⇒ <code>\*</code>
+Function to execute on each property in the object, taking four arguments
+
+**Kind**: inner typedef of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [accumulator] | <code>\*</code> | <code>{}</code> | The accumulator accumulates the callback's return values; it is the accumulated value previously returned in the last invocation of the callback, or initialValue, if supplied (see below). |
+| [currentProperty] | <code>\*</code> | <code>{}</code> | The current property being processed in the object. |
+| [currentIndex] | <code>string</code> | <code>0</code> | The index of the current element being processed in the array. Starts at index 0, if an initialValue is provided, and at index 1 otherwise. |
+| [object] | <code>Object</code> \| <code>Array</code> | <code>{}</code> | The object reduce was called upon. |
+
+<a name="module_objectHelpers..mergeObjectsCallback"></a>
+
+### objectHelpers~mergeObjectsCallback ⇒ <code>\*</code>
+Function that takes one or more objects and combines them into one.
+
+**Kind**: inner typedef of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ...objects | <code>Object</code> | Provide a list of objects which will be merged starting from the end up into the first |
+
+<a name="module_objectHelpers..mapCallback"></a>
+
+### objectHelpers~mapCallback ⇒ <code>\*</code>
+Function that produces a property of the new Object, taking three arguments
+
+**Kind**: inner typedef of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| currentProperty | <code>\*</code> | The current property being processed in the object. |
+| [currentIndex] | <code>string</code> | The property name of the current property being processed in the object. |
+| [object] | <code>Object</code> \| <code>Array</code> | The object map was called upon. |
+
+<a name="module_objectHelpers..filterCallback"></a>
+
+### objectHelpers~filterCallback ⇒ <code>boolean</code>
+Function is a predicate, to test each property value of the object. Return true to keep the element, false
+
+**Kind**: inner typedef of [<code>objectHelpers</code>](#module_objectHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| currentProperty | <code>\*</code> | The current property being processed in the object. |
+| [currentIndex] | <code>string</code> | The property name of the current property being processed in the object. |
+| [object] | <code>Object</code> \| <code>Array</code> | The object filter was called upon. |
+
+<a name="module_numberHelpers"></a>
+
+## numberHelpers
+Some number comparators and random number generators.
+
+**Version**: 1.0.0  
+**Author**: Joshua Heagle <joshuaheagle@gmail.com>  
+
+* [numberHelpers](#module_numberHelpers)
+    * [.randomNumber(range, [offset], [interval])](#module_numberHelpers.randomNumber) ⇒ <code>number</code>
+    * [.randomInteger(range, [offset], [interval])](#module_numberHelpers.randomInteger) ⇒ <code>number</code>
+    * [.compare(val1, val2)](#module_numberHelpers.compare) ⇒ <code>number</code>
+    * [.absoluteMin(num1, num2)](#module_numberHelpers.absoluteMin) ⇒ <code>number</code>
+    * [.absoluteMax(num1, num2)](#module_numberHelpers.absoluteMax) ⇒ <code>number</code>
+
+<a name="module_numberHelpers.randomNumber"></a>
+
+### numberHelpers.randomNumber(range, [offset], [interval]) ⇒ <code>number</code>
+Create a single random number within provided range. And with optional offset,
+
+**Kind**: static method of [<code>numberHelpers</code>](#module_numberHelpers)  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| range | <code>number</code> |  | Choose the breadth of the random number (0-100 would be 100 for range) |
+| [offset] | <code>number</code> | <code>0</code> | Choose the starting number (1-10 would be 1 for offset, 9 for range) |
+| [interval] | <code>number</code> | <code>1</code> | Choose the distance between numbers (~5, ~10, ~15 would be 5 for interval, 1 for offset, 2 for range) |
+
+<a name="module_numberHelpers.randomInteger"></a>
+
+### numberHelpers.randomInteger(range, [offset], [interval]) ⇒ <code>number</code>
+Create a single random integer within provide range. And with optional offset,
+
+**Kind**: static method of [<code>numberHelpers</code>](#module_numberHelpers)  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| range | <code>number</code> |  | Choose the breadth of the random number (0-100 would be 100 for range) |
+| [offset] | <code>number</code> | <code>0</code> | Choose the starting number (1-10 would be 1 for offset, 9 for range) |
+| [interval] | <code>number</code> | <code>1</code> | Choose the distance between numbers (5, 10, 15 would be 5 for interval, 1 for offset, 2 for range) |
+
+<a name="module_numberHelpers.compare"></a>
+
+### numberHelpers.compare(val1, val2) ⇒ <code>number</code>
+Compare two numbers and return:
+
+**Kind**: static method of [<code>numberHelpers</code>](#module_numberHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| val1 | <code>number</code> | The first number to compare |
+| val2 | <code>number</code> | The second number to compare |
+
+<a name="module_numberHelpers.absoluteMin"></a>
+
+### numberHelpers.absoluteMin(num1, num2) ⇒ <code>number</code>
+Helper for returning the absolute min value
+
+**Kind**: static method of [<code>numberHelpers</code>](#module_numberHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| num1 | <code>number</code> | A number to compare |
+| num2 | <code>number</code> | Another number to be compared against |
+
+<a name="module_numberHelpers.absoluteMax"></a>
+
+### numberHelpers.absoluteMax(num1, num2) ⇒ <code>number</code>
+Helper for returning the absolute max value
+
+**Kind**: static method of [<code>numberHelpers</code>](#module_numberHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| num1 | <code>number</code> | A number to compare |
+| num2 | <code>number</code> | Another number to be compared against |
+
+<a name="module_functionHelpers"></a>
+
+## functionHelpers
+Manage how functions are called with these utilities.
+
+**Version**: 1.0.0  
+**Author**: Joshua Heagle <joshuaheagle@gmail.com>  
+
+* [functionHelpers](#module_functionHelpers)
+    * _static_
+        * [.trace(label, useClone)](#module_functionHelpers.trace) ⇒ <code>function</code>
+        * [.relevancyFilter(map, [options])](#module_functionHelpers.relevancyFilter) ⇒ <code>relevanceMap</code>
+        * [.queueTimeout([queueManagerHandle])](#module_functionHelpers.queueTimeout) ⇒ [<code>queueTimeoutHandle</code>](#module_functionHelpers..queueTimeoutHandle)
+        * [.queueManager([queue])](#module_functionHelpers.queueManager) ⇒ [<code>queueManagerHandle</code>](#module_functionHelpers..queueManagerHandle)
+        * [.preloadParams(fn, params, [unassignedParam])](#module_functionHelpers.preloadParams) ⇒ [<code>callWithMissing</code>](#module_functionHelpers..callWithMissing)
+        * [.pipe(...fns)](#module_functionHelpers.pipe) ⇒ <code>\*</code>
+        * [.onBodyLoad(callback, [reset])](#module_functionHelpers.onBodyLoad) ⇒ <code>Array.&lt;function()&gt;</code>
+        * [.delay(time)](#module_functionHelpers.delay) ⇒ [<code>delayHandler</code>](#module_functionHelpers..delayHandler)
+        * [.curry(fn)](#module_functionHelpers.curry) ⇒ <code>function</code> \| <code>\*</code>
+        * [.callWithParams(fn, params, [minimum])](#module_functionHelpers.callWithParams) ⇒ <code>\*</code>
+        * [.relevanceObject](#module_functionHelpers.relevanceObject) : <code>Object</code>
+        * [.relevanceMap](#module_functionHelpers.relevanceMap) : <code>Array.&lt;relevanceObject&gt;</code>
+    * _inner_
+        * [~queueTimeoutHandle](#module_functionHelpers..queueTimeoutHandle) ⇒ <code>Promise</code>
+        * [~queueManagerHandle](#module_functionHelpers..queueManagerHandle) ⇒ <code>Promise</code>
+        * [~callWithMissing](#module_functionHelpers..callWithMissing) ⇒ <code>\*</code>
+        * [~delayHandler](#module_functionHelpers..delayHandler) : <code>Object</code>
+
+<a name="module_functionHelpers.trace"></a>
+
+### functionHelpers.trace(label, useClone) ⇒ <code>function</code>
+Output the a value with label to the console and return the value to not interrupt the code.
+
+**Kind**: static method of [<code>functionHelpers</code>](#module_functionHelpers)  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| label | <code>string</code> |  | Pass an identifying label of the value being output. |
+| useClone |  | <code>true</code> | Determines if the logged data should be a clone of the original to preserve state. |
+
+<a name="module_functionHelpers.relevancyFilter"></a>
+
+### functionHelpers.relevancyFilter(map, [options]) ⇒ <code>relevanceMap</code>
+Remove elements out of relevance range and update the max relevance.
+
+**Kind**: static method of [<code>functionHelpers</code>](#module_functionHelpers)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| map | <code>relevanceMap</code> |  | 
+| [options] | <code>Object</code> | <code>{}</code> | 
+| [options.mapLimit] | <code>int</code> | <code>1000</code> | 
+| [options.relevancyRange] | <code>int</code> | <code>100</code> | 
+
+<a name="module_functionHelpers.queueTimeout"></a>
+
+### functionHelpers.queueTimeout([queueManagerHandle]) ⇒ [<code>queueTimeoutHandle</code>](#module_functionHelpers..queueTimeoutHandle)
+Manage functions to run sequentially with delays.
+
+**Kind**: static method of [<code>functionHelpers</code>](#module_functionHelpers)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| [queueManagerHandle] | [<code>queueManagerHandle</code>](#module_functionHelpers..queueManagerHandle) | <code></code> | 
+
+<a name="module_functionHelpers.queueManager"></a>
+
+### functionHelpers.queueManager([queue]) ⇒ [<code>queueManagerHandle</code>](#module_functionHelpers..queueManagerHandle)
+Manage functions to run sequentially.
+
+**Kind**: static method of [<code>functionHelpers</code>](#module_functionHelpers)  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [queue] | <code>Iterable</code> \| <code>array</code> | <code>[]</code> | The iterable that can be used to store queued functions |
+
+<a name="module_functionHelpers.preloadParams"></a>
+
+### functionHelpers.preloadParams(fn, params, [unassignedParam]) ⇒ [<code>callWithMissing</code>](#module_functionHelpers..callWithMissing)
+Provide an array of parameters to be used with a function, allow the function to be called later
+
+**Kind**: static method of [<code>functionHelpers</code>](#module_functionHelpers)  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| fn | <code>function</code> |  | The function to be called |
+| params | <code>Array</code> |  | The parameters to preload |
+| [unassignedParam] | <code>number</code> | <code>0</code> | Position of missing parameter (zero indexed) |
+
+<a name="module_functionHelpers.pipe"></a>
+
+### functionHelpers.pipe(...fns) ⇒ <code>\*</code>
+Take one or more function with a single parameter and return value.
+
+**Kind**: static method of [<code>functionHelpers</code>](#module_functionHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ...fns | <code>function</code> | Takes a series of functions having the same parameter |
+
+<a name="module_functionHelpers.onBodyLoad"></a>
+
+### functionHelpers.onBodyLoad(callback, [reset]) ⇒ <code>Array.&lt;function()&gt;</code>
+Prepare functions to be called once the body is available.
+
+**Kind**: static method of [<code>functionHelpers</code>](#module_functionHelpers)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| callback | <code>function</code> |  | 
+| [reset] | <code>boolean</code> | <code>false</code> | 
+
+<a name="module_functionHelpers.delay"></a>
+
+### functionHelpers.delay(time) ⇒ [<code>delayHandler</code>](#module_functionHelpers..delayHandler)
+Provide a timeout which returns a promise.
+
+**Kind**: static method of [<code>functionHelpers</code>](#module_functionHelpers)  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| time | <code>number</code> | <code>0</code> | Delay in milliseconds |
+
+<a name="module_functionHelpers.curry"></a>
+
+### functionHelpers.curry(fn) ⇒ <code>function</code> \| <code>\*</code>
+Return a curried version of the passed function.
+
+**Kind**: static method of [<code>functionHelpers</code>](#module_functionHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| fn | <code>function</code> | Receives a function to be curried |
+
+<a name="module_functionHelpers.callWithParams"></a>
+
+### functionHelpers.callWithParams(fn, params, [minimum]) ⇒ <code>\*</code>
+Given a function, call with the correct number of paramters from an array of possible parameters.
+
+**Kind**: static method of [<code>functionHelpers</code>](#module_functionHelpers)  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| fn | <code>function</code> |  | The function to be called |
+| params | <code>Array</code> |  | Array of possible function parameters |
+| [minimum] | <code>number</code> | <code>2</code> | Minimumn number of parameters to use in the function |
+
+<a name="module_functionHelpers.relevanceObject"></a>
+
+### functionHelpers.relevanceObject : <code>Object</code>
+An object having an integer valued property named 'relevance'.
+
+**Kind**: static typedef of [<code>functionHelpers</code>](#module_functionHelpers)  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| relevance | <code>int</code> | 
+
+<a name="module_functionHelpers.relevanceMap"></a>
+
+### functionHelpers.relevanceMap : <code>Array.&lt;relevanceObject&gt;</code>
+A map of relevanceObjects which can be manipulated to filter results.
+
+**Kind**: static typedef of [<code>functionHelpers</code>](#module_functionHelpers)  
+<a name="module_functionHelpers..queueTimeoutHandle"></a>
+
+### functionHelpers~queueTimeoutHandle ⇒ <code>Promise</code>
+Run Timeout functions one after the otherin queue.
+
+**Kind**: inner typedef of [<code>functionHelpers</code>](#module_functionHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| fn | <code>function</code> | A callback function to be performed at some time in the future. |
+| time | <code>number</code> | The time in milliseconds to delay. |
+| ...args | <code>\*</code> | Arguments to be passed to the callback once it is implemented. |
+
+<a name="module_functionHelpers..queueManagerHandle"></a>
+
+### functionHelpers~queueManagerHandle ⇒ <code>Promise</code>
+Each time queue handle is called the passed function is added to the queue to be called when ready.
+
+**Kind**: inner typedef of [<code>functionHelpers</code>](#module_functionHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| fn | <code>function</code> | A function to enqueue |
+| ...args | <code>\*</code> | Arguments to be passed to the function once it is ready |
+
+<a name="module_functionHelpers..callWithMissing"></a>
+
+### functionHelpers~callWithMissing ⇒ <code>\*</code>
+The return function which takes the missing parameter in order to call the preloaded function.
+
+**Kind**: inner typedef of [<code>functionHelpers</code>](#module_functionHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| missing | <code>\*</code> | The missing parameter to be applied |
+
+<a name="module_functionHelpers..delayHandler"></a>
+
+### functionHelpers~delayHandler : <code>Object</code>
+Provide a way to cancel a request or attach a resolve event.
+
+**Kind**: inner typedef of [<code>functionHelpers</code>](#module_functionHelpers)  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| resolver | <code>Promise</code> | 
+| cancel | <code>function</code> | 
+
+<a name="module_objectDescriptors"></a>
+
+## objectDescriptors
+Create a format to standardize every object into a specific template.
+
+**Version**: 1.0.0  
+**Author**: Joshua Heagle <joshuaheagle@gmail.com>  
+
+* [objectDescriptors](#module_objectDescriptors)
+    * _static_
+        * [.mappedDescriptorMap](#module_objectDescriptors.mappedDescriptorMap) : [<code>descriptorMap</code>](#module_objectDescriptors..descriptorMap)
+        * [.descriptorMapSample](#module_objectDescriptors.descriptorMapSample) : [<code>descriptorMap</code>](#module_objectDescriptors..descriptorMap)
+        * [.descriptorDetailSample](#module_objectDescriptors.descriptorDetailSample) : [<code>descriptorDetail</code>](#module_objectDescriptors..descriptorDetail)
+        * [.descriptorSample](#module_objectDescriptors.descriptorSample) : [<code>descriptor</code>](#module_objectDescriptors..descriptor)
+        * [.sameDescriptor(descriptor1, descriptor2)](#module_objectDescriptors.sameDescriptor) ⇒ <code>boolean</code>
+        * [.nextReference(descriptor, currentReference)](#module_objectDescriptors.nextReference) ⇒ <code>number</code> \| <code>undefined</code>
+        * [.describeObjectMap(object, [options])](#module_objectDescriptors.describeObjectMap) ⇒ [<code>descriptorMap</code>](#module_objectDescriptors..descriptorMap)
+        * [.describeObjectDetail(value, [key], [index])](#module_objectDescriptors.describeObjectDetail) ⇒ [<code>descriptorDetail</code>](#module_objectDescriptors..descriptorDetail)
+        * [.describeObject(object)](#module_objectDescriptors.describeObject) ⇒ [<code>descriptor</code>](#module_objectDescriptors..descriptor)
+        * [.compareDescriptor(descriptor1, descriptor2)](#module_objectDescriptors.compareDescriptor) ⇒ <code>boolean</code>
+        * [.cloneDescriptorDetail(originalDetail)](#module_objectDescriptors.cloneDescriptorDetail) ⇒ [<code>descriptorDetail</code>](#module_objectDescriptors..descriptorDetail)
+        * [.cloneDescriptor(originalMap)](#module_objectDescriptors.cloneDescriptor) ⇒ [<code>descriptor</code>](#module_objectDescriptors..descriptor)
+        * [.checkDescriptorComplete(descriptor)](#module_objectDescriptors.checkDescriptorComplete) ⇒ [<code>descriptor</code>](#module_objectDescriptors..descriptor)
+        * [.checkClearValues(descriptor, [keepValues])](#module_objectDescriptors.checkClearValues) ⇒ [<code>descriptor</code>](#module_objectDescriptors..descriptor)
+        * [.assignDescriptorDetail(originalDetail, ...details)](#module_objectDescriptors.assignDescriptorDetail) ⇒ [<code>descriptorDetail</code>](#module_objectDescriptors..descriptorDetail)
+        * [.assignDescriptor(originalMap, ...descriptors)](#module_objectDescriptors.assignDescriptor) ⇒ [<code>descriptor</code>](#module_objectDescriptors..descriptor)
+    * _inner_
+        * [~descriptorMap](#module_objectDescriptors..descriptorMap) : [<code>Array.&lt;descriptor&gt;</code>](#module_objectDescriptors..descriptor)
+        * [~descriptorDetail](#module_objectDescriptors..descriptorDetail) : <code>Object</code>
+        * [~descriptor](#module_objectDescriptors..descriptor) : <code>Object</code>
+
+<a name="module_objectDescriptors.mappedDescriptorMap"></a>
+
+### objectDescriptors.mappedDescriptorMap : [<code>descriptorMap</code>](#module_objectDescriptors..descriptorMap)
+**Kind**: static constant of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+<a name="module_objectDescriptors.descriptorMapSample"></a>
+
+### objectDescriptors.descriptorMapSample : [<code>descriptorMap</code>](#module_objectDescriptors..descriptorMap)
+**Kind**: static constant of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+<a name="module_objectDescriptors.descriptorDetailSample"></a>
+
+### objectDescriptors.descriptorDetailSample : [<code>descriptorDetail</code>](#module_objectDescriptors..descriptorDetail)
+**Kind**: static constant of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+<a name="module_objectDescriptors.descriptorSample"></a>
+
+### objectDescriptors.descriptorSample : [<code>descriptor</code>](#module_objectDescriptors..descriptor)
+**Kind**: static constant of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+<a name="module_objectDescriptors.sameDescriptor"></a>
+
+### objectDescriptors.sameDescriptor(descriptor1, descriptor2) ⇒ <code>boolean</code>
+Check if the two descriptors are the same.
+
+**Kind**: static method of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+
+| Param | Type |
+| --- | --- |
+| descriptor1 | [<code>descriptor</code>](#module_objectDescriptors..descriptor) | 
+| descriptor2 | [<code>descriptor</code>](#module_objectDescriptors..descriptor) | 
+
+<a name="module_objectDescriptors.nextReference"></a>
+
+### objectDescriptors.nextReference(descriptor, currentReference) ⇒ <code>number</code> \| <code>undefined</code>
+Find the index of the next module:objectDescriptors.descriptorDetail to build a resource for.
+
+**Kind**: static method of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+
+| Param | Type |
+| --- | --- |
+| descriptor | [<code>descriptor</code>](#module_objectDescriptors..descriptor) | 
+| currentReference | <code>number</code> | 
+
+<a name="module_objectDescriptors.describeObjectMap"></a>
+
+### objectDescriptors.describeObjectMap(object, [options]) ⇒ [<code>descriptorMap</code>](#module_objectDescriptors..descriptorMap)
+Trace out the entire object including nested objects.
+
+**Kind**: static method of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| object | <code>Object</code> \| <code>Array</code> |  | 
+| [options] | <code>Object</code> | <code>{}</code> | 
+| [options.mapLimit] | <code>number</code> | <code>1000000000</code> | 
+| [options.depthLimit] | <code>number</code> | <code>-1</code> | 
+| [options.keepValues] | <code>boolean</code> | <code>false</code> | 
+
+<a name="module_objectDescriptors.describeObjectDetail"></a>
+
+### objectDescriptors.describeObjectDetail(value, [key], [index]) ⇒ [<code>descriptorDetail</code>](#module_objectDescriptors..descriptorDetail)
+Trace an object's attribute and provide details about it.
+
+**Kind**: static method of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| value | <code>\*</code> |  | 
+| [key] | <code>string</code> \| <code>number</code> | <code>0</code> | 
+| [index] | <code>number</code> | <code>0</code> | 
+
+<a name="module_objectDescriptors.describeObject"></a>
+
+### objectDescriptors.describeObject(object) ⇒ [<code>descriptor</code>](#module_objectDescriptors..descriptor)
+Trace an object and return the descriptor which defines the object's structure and attributes.
+
+**Kind**: static method of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+
+| Param | Type |
+| --- | --- |
+| object | <code>Object</code> | 
+
+<a name="module_objectDescriptors.compareDescriptor"></a>
+
+### objectDescriptors.compareDescriptor(descriptor1, descriptor2) ⇒ <code>boolean</code>
+Check if two descriptors are the same or similar in that they have similar keys and the associated types are the same.
+
+**Kind**: static method of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+
+| Param | Type |
+| --- | --- |
+| descriptor1 | [<code>descriptor</code>](#module_objectDescriptors..descriptor) | 
+| descriptor2 | [<code>descriptor</code>](#module_objectDescriptors..descriptor) | 
+
+<a name="module_objectDescriptors.cloneDescriptorDetail"></a>
+
+### objectDescriptors.cloneDescriptorDetail(originalDetail) ⇒ [<code>descriptorDetail</code>](#module_objectDescriptors..descriptorDetail)
+Get a new copy of an existing Descriptor Detail
+
+**Kind**: static method of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+
+| Param | Type |
+| --- | --- |
+| originalDetail | [<code>descriptorDetail</code>](#module_objectDescriptors..descriptorDetail) | 
+
+<a name="module_objectDescriptors.cloneDescriptor"></a>
+
+### objectDescriptors.cloneDescriptor(originalMap) ⇒ [<code>descriptor</code>](#module_objectDescriptors..descriptor)
+Make a copy of an object descriptor so that the original will not be mutated.
+
+**Kind**: static method of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+
+| Param | Type |
+| --- | --- |
+| originalMap | [<code>descriptor</code>](#module_objectDescriptors..descriptor) | 
+
+<a name="module_objectDescriptors.checkDescriptorComplete"></a>
+
+### objectDescriptors.checkDescriptorComplete(descriptor) ⇒ [<code>descriptor</code>](#module_objectDescriptors..descriptor)
+Check if the descriptors references have all been built and set complete to true if they have.
+
+**Kind**: static method of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+
+| Param | Type |
+| --- | --- |
+| descriptor | [<code>descriptor</code>](#module_objectDescriptors..descriptor) | 
+
+<a name="module_objectDescriptors.checkClearValues"></a>
+
+### objectDescriptors.checkClearValues(descriptor, [keepValues]) ⇒ [<code>descriptor</code>](#module_objectDescriptors..descriptor)
+Check if we should clear the values on this descriptor
+
+**Kind**: static method of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| descriptor | [<code>descriptor</code>](#module_objectDescriptors..descriptor) |  | 
+| [keepValues] | <code>boolean</code> | <code>false</code> | 
+
+<a name="module_objectDescriptors.assignDescriptorDetail"></a>
+
+### objectDescriptors.assignDescriptorDetail(originalDetail, ...details) ⇒ [<code>descriptorDetail</code>](#module_objectDescriptors..descriptorDetail)
+Assign properties from other details onto an existing detail.
+
+**Kind**: static method of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+
+| Param | Type |
+| --- | --- |
+| originalDetail | [<code>descriptorDetail</code>](#module_objectDescriptors..descriptorDetail) | 
+| ...details | [<code>descriptorDetail</code>](#module_objectDescriptors..descriptorDetail) | 
+
+<a name="module_objectDescriptors.assignDescriptor"></a>
+
+### objectDescriptors.assignDescriptor(originalMap, ...descriptors) ⇒ [<code>descriptor</code>](#module_objectDescriptors..descriptor)
+Apply one or more descriptors to an existing descriptor so that they represent a merged version of the descriptors.
+
+**Kind**: static method of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+
+| Param | Type |
+| --- | --- |
+| originalMap | [<code>descriptor</code>](#module_objectDescriptors..descriptor) | 
+| ...descriptors | [<code>descriptor</code>](#module_objectDescriptors..descriptor) | 
+
+<a name="module_objectDescriptors..descriptorMap"></a>
+
+### objectDescriptors~descriptorMap : [<code>Array.&lt;descriptor&gt;</code>](#module_objectDescriptors..descriptor)
+**Kind**: inner typedef of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+<a name="module_objectDescriptors..descriptorDetail"></a>
+
+### objectDescriptors~descriptorDetail : <code>Object</code>
+**Kind**: inner typedef of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| index | <code>number</code> | 
+| key | <code>string</code> \| <code>number</code> | 
+| type | <code>Array.&lt;string&gt;</code> | 
+| value | <code>Array</code> | 
+| nullable | <code>boolean</code> | 
+| optional | <code>boolean</code> | 
+| circular | <code>boolean</code> | 
+| isReference | <code>boolean</code> | 
+| isInstance | <code>boolean</code> | 
+| arrayReference | <code>null</code> \| <code>number</code> | 
+| objectReference | <code>null</code> \| <code>number</code> | 
+
+<a name="module_objectDescriptors..descriptor"></a>
+
+### objectDescriptors~descriptor : <code>Object</code>
+**Kind**: inner typedef of [<code>objectDescriptors</code>](#module_objectDescriptors)  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| index | <code>number</code> | 
+| details | [<code>Array.&lt;descriptorDetail&gt;</code>](#module_objectDescriptors..descriptorDetail) | 
+| length | <code>number</code> | 
+| keys | <code>Array.&lt;(string\|number)&gt;</code> | 
+| references | <code>Array.&lt;number&gt;</code> | 
+| isArray | <code>boolean</code> | 
+| complete | <code>boolean</code> | 
+
+<a name="module_arrayHelpers"></a>
+
+## arrayHelpers
+Some simple utility functions for generating arrays or performing work on arrays.
+
+**Version**: 1.0.0  
+**Author**: Joshua Heagle <joshuaheagle@gmail.com>  
+
+* [arrayHelpers](#module_arrayHelpers)
+    * _static_
+        * [.uniqueArray(array)](#module_arrayHelpers.uniqueArray) ⇒ <code>Array</code>
+        * [.mergeArrays(...arrays)](#module_arrayHelpers.mergeArrays) ⇒ <code>Array</code>
+        * [.compareArrays(...arrays)](#module_arrayHelpers.compareArrays) ⇒ [<code>Array.&lt;compareArrayResult&gt;</code>](#module_arrayHelpers..compareArrayResult)
+        * [.buildArrayOfReferences(item, length)](#module_arrayHelpers.buildArrayOfReferences) ⇒ <code>Array.&lt;\*&gt;</code>
+        * [.buildArray(item, length)](#module_arrayHelpers.buildArray) ⇒ <code>Array.&lt;\*&gt;</code>
+        * [.addUniqueToArray(item, array)](#module_arrayHelpers.addUniqueToArray) ⇒ <code>Array</code> \| <code>Buffer</code> \| <code>\*</code> \| <code>string</code>
+    * _inner_
+        * [~compareArrayResult](#module_arrayHelpers..compareArrayResult) : <code>Object.&lt;string, (string\|Array.&lt;number&gt;)&gt;</code>
+
+<a name="module_arrayHelpers.uniqueArray"></a>
+
+### arrayHelpers.uniqueArray(array) ⇒ <code>Array</code>
+Remove duplicate values from an array.
+
+**Kind**: static method of [<code>arrayHelpers</code>](#module_arrayHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| array | <code>Array</code> | The array to make unique |
+
+<a name="module_arrayHelpers.mergeArrays"></a>
+
+### arrayHelpers.mergeArrays(...arrays) ⇒ <code>Array</code>
+Take multiple arrays and then filter all these into one unique array.
+
+**Kind**: static method of [<code>arrayHelpers</code>](#module_arrayHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ...arrays | <code>Array</code> | Provide multiple arrays to create one unique array |
+
+<a name="module_arrayHelpers.compareArrays"></a>
+
+### arrayHelpers.compareArrays(...arrays) ⇒ [<code>Array.&lt;compareArrayResult&gt;</code>](#module_arrayHelpers..compareArrayResult)
+Compare two Arrays and return the Object where the value for each property is as follows:
+
+**Kind**: static method of [<code>arrayHelpers</code>](#module_arrayHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ...arrays | <code>Array</code> | The arrays to compare |
+
+**Example**  
+```js
+// example of input and resulting output
  ['match1', 'firstMismatch1', 'match2', 'firstMismatch2', 'badMatch1'],
  ['match1', 'match2', 'secondMismatch1', 'badMatch1', 'badMatch1']
  {
    value: 'match1',
    keys: [[0], [0]],
    result: [0, 0]
  },
  {
    value: 'firstMismatch1',
    keys: [[1], []],
    result: [1, -1]
  },
  {
    value: 'match2',
    keys: [[2], [1]],
    result: [0, 0]
  },
  {
    value: 'firstMismatch2',
    keys: [[3], []],
    result: [1, -1]
  },
  {
    value: 'badMatch1',
    keys: [[4], [3, 4]],
    result: [0, 0]
  },
  {
    value: 'secondMismatch1',
    keys: [[], [2]],
    result: [-1, 1]
  }
- value stores the element value from the arrays being compared
- results has the comparison results where first index (0) is result for first compared array
+```
+<a name="module_arrayHelpers.buildArrayOfReferences"></a>
+
+### arrayHelpers.buildArrayOfReferences(item, length) ⇒ <code>Array.&lt;\*&gt;</code>
+Leverage buildArrayBase to generate an array filled with references to the provided item.
+
+**Kind**: static method of [<code>arrayHelpers</code>](#module_arrayHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| item | <code>\*</code> | The item to be used for each array element |
+| length | <code>number</code> | The desired length of the array |
+
+<a name="module_arrayHelpers.buildArray"></a>
+
+### arrayHelpers.buildArray(item, length) ⇒ <code>Array.&lt;\*&gt;</code>
+Leverage buildArrayBase to generate an array filled with a copy of the provided item.
+
+**Kind**: static method of [<code>arrayHelpers</code>](#module_arrayHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| item | <code>\*</code> | The item to be used for each array element |
+| length | <code>number</code> | The desired length of the array |
+
+<a name="module_arrayHelpers.addUniqueToArray"></a>
+
+### arrayHelpers.addUniqueToArray(item, array) ⇒ <code>Array</code> \| <code>Buffer</code> \| <code>\*</code> \| <code>string</code>
+Having an array and a potential new array element, check if the element is in the array, if not append to array.
+
+**Kind**: static method of [<code>arrayHelpers</code>](#module_arrayHelpers)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| item | <code>\*</code> | An potential array element, possibly a DomItem |
+| array | <code>Array</code> | An array where an element may be appended. |
+
+<a name="module_arrayHelpers..compareArrayResult"></a>
+
+### arrayHelpers~compareArrayResult : <code>Object.&lt;string, (string\|Array.&lt;number&gt;)&gt;</code>
+Store the comparison result for an element that may exist in either of compared arrays.
  and the second index (1) will be the result for the second compared array
+
+**Kind**: inner typedef of [<code>arrayHelpers</code>](#module_arrayHelpers)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| value | <code>string</code> | The element value being compared |
+| keys | <code>Array.&lt;Array.&lt;(string\|number)&gt;&gt;</code> | Keys in arrays associated with this value |
+| result | <code>Array.&lt;number&gt;</code> | The results in the order of the compared arrays |
+
+**Example**  
+```js
+// example of input and resulting output
+```