si-funciona 1.2.0 → 2.0.0

package/dist/helpers/numbers/randomInteger.js

@@ -5,16 +5,16 @@ Object.defineProperty(exports, '__esModule', {
 })
 exports.default = void 0
 require('core-js/stable')
-/**
- * Create a single random integer within provide range. And with optional offset,
- * The distance between the result numbers can be adjusted with interval.
- * @function
- * @memberOf module:numberHelpers
- * @param {number} range - Choose the breadth of the random number (0-100 would be 100 for range)
- * @param {number} [offset=0] - Choose the starting number (1-10 would be 1 for offset, 9 for range)
- * @param {number} [interval=1] - Choose the distance between numbers (5, 10, 15 would be 5 for interval, 1 for
- * offset, 2 for range)
- * @returns {number}
+/**
+ * Create a single random integer within provide range. And with optional offset,
+ * The distance between the result numbers can be adjusted with interval.
+ * @function
+ * @memberOf module:numberHelpers
+ * @param {number} range - Choose the breadth of the random number (0-100 would be 100 for range)
+ * @param {number} [offset=0] - Choose the starting number (1-10 would be 1 for offset, 9 for range)
+ * @param {number} [interval=1] - Choose the distance between numbers (5, 10, 15 would be 5 for interval, 1 for
+ * offset, 2 for range)
+ * @returns {number}
  */
 const randomInteger = function (range) {
   const offset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0

package/dist/helpers/numbers/randomNumber.js

@@ -5,16 +5,16 @@ Object.defineProperty(exports, '__esModule', {
 })
 exports.default = void 0
 require('core-js/stable')
-/**
- * Create a single random number within provided range. And with optional offset,
- * The distance between the result numbers can be adjusted with interval.
- * @function
- * @memberOf module:numberHelpers
- * @param {number} range - Choose the breadth of the random number (0-100 would be 100 for range)
- * @param {number} [offset=0] - Choose the starting number (1-10 would be 1 for offset, 9 for range)
- * @param {number} [interval=1] - Choose the distance between numbers (~5, ~10, ~15 would be 5 for interval, 1 for
- * offset, 2 for range)
- * @returns {number}
+/**
+ * Create a single random number within provided range. And with optional offset,
+ * The distance between the result numbers can be adjusted with interval.
+ * @function
+ * @memberOf module:numberHelpers
+ * @param {number} range - Choose the breadth of the random number (0-100 would be 100 for range)
+ * @param {number} [offset=0] - Choose the starting number (1-10 would be 1 for offset, 9 for range)
+ * @param {number} [interval=1] - Choose the distance between numbers (~5, ~10, ~15 would be 5 for interval, 1 for
+ * offset, 2 for range)
+ * @returns {number}
  */
 const randomNumber = function (range) {
   const offset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0

package/dist/helpers/numbers.js

@@ -5,19 +5,19 @@ Object.defineProperty(exports, '__esModule', {
 })
 exports.default = void 0
 require('core-js/stable')
-var _absoluteMax = _interopRequireDefault(require('./numbers/absoluteMax.js'))
-var _absoluteMin = _interopRequireDefault(require('./numbers/absoluteMin.js'))
-var _compare = _interopRequireDefault(require('./numbers/compare.js'))
-var _randomInteger = _interopRequireDefault(require('./numbers/randomInteger.js'))
-var _randomNumber = _interopRequireDefault(require('./numbers/randomNumber.js'))
+var _absoluteMax = _interopRequireDefault(require('./numbers/absoluteMax'))
+var _absoluteMin = _interopRequireDefault(require('./numbers/absoluteMin'))
+var _compare = _interopRequireDefault(require('./numbers/compare'))
+var _randomInteger = _interopRequireDefault(require('./numbers/randomInteger'))
+var _randomNumber = _interopRequireDefault(require('./numbers/randomNumber'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
-/**
- * Some number comparators and random number generators.
- * @file
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @module numberHelpers
- * @memberOf module:siFunciona
+/**
+ * Some number comparators and random number generators.
+ * @file
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @module numberHelpers
+ * @memberOf module:siFunciona
  */
 var _default = {
   absoluteMax: _absoluteMax.default,

package/dist/helpers/numbers.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _absoluteMax=_interopRequireDefault(require("./numbers/absoluteMax.js")),_absoluteMin=_interopRequireDefault(require("./numbers/absoluteMin.js")),_compare=_interopRequireDefault(require("./numbers/compare.js")),_randomInteger=_interopRequireDefault(require("./numbers/randomInteger.js")),_randomNumber=_interopRequireDefault(require("./numbers/randomNumber.js"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}var _default={absoluteMax:_absoluteMax.default,absoluteMin:_absoluteMin.default,compare:_compare.default,randomInteger:_randomInteger.default,randomNumber:_randomNumber.default};exports.default=_default;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _absoluteMax=_interopRequireDefault(require("./numbers/absoluteMax")),_absoluteMin=_interopRequireDefault(require("./numbers/absoluteMin")),_compare=_interopRequireDefault(require("./numbers/compare")),_randomInteger=_interopRequireDefault(require("./numbers/randomInteger")),_randomNumber=_interopRequireDefault(require("./numbers/randomNumber"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}var _default={absoluteMax:_absoluteMax.default,absoluteMin:_absoluteMin.default,compare:_compare.default,randomInteger:_randomInteger.default,randomNumber:_randomNumber.default};exports.default=_default;

package/dist/helpers/objects/cloneObject.js

@@ -7,18 +7,18 @@ exports.default = void 0
 require('core-js/stable')
 var _mergeObjectsBase = _interopRequireDefault(require('./mergeObjectsBase'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
-/**
- * Clone objects for manipulation without data corruption, returns a copy of the provided object.
- * NOTE: Use the mapLimit and relevancyRange to resolve "too much recursion" when the object is large and is known to
- * have circular references. A high mapLimit may lead to heavy memory usage and slow performance.
- * @function
- * @memberOf module:objectHelpers
- * @param {Object} object - The original object that is being cloned
- * @param {Object} [options={}]
- * @param {number} [options.mapLimit=100] - Size of temporary reference array used in memory before assessing relevancy.
- * @param {number} [options.depthLimit=-1] - Control how many nested levels deep will be used, -1 = no limit, >-1 = nth level limited.
- * @param {number} [options.relevancyRange=1000] - Total reference map length subtract this range, any relevancy less than that amount at time of evaluation will be removed.
- * @returns {Object}
+/**
+ * Clone objects for manipulation without data corruption, returns a copy of the provided object.
+ * NOTE: Use the mapLimit and relevancyRange to resolve "too much recursion" when the object is large and is known to
+ * have circular references. A high mapLimit may lead to heavy memory usage and slow performance.
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Object} object - The original object that is being cloned
+ * @param {Object} [options={}]
+ * @param {number} [options.mapLimit=100] - Size of temporary reference array used in memory before assessing relevancy.
+ * @param {number} [options.depthLimit=-1] - Control how many nested levels deep will be used, -1 = no limit, >-1 = nth level limited.
+ * @param {number} [options.relevancyRange=1000] - Total reference map length subtract this range, any relevancy less than that amount at time of evaluation will be removed.
+ * @returns {Object}
  */
 const cloneObject = function (object) {
   const {

package/dist/helpers/objects/dotGet.js

@@ -20,6 +20,7 @@ function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { d
  */
 const dotGet = function (arrayObject, dotNotation) {
   const defaultValue = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null
+  var _a
   let key = (0, _strBefore.default)(dotNotation, '.')
   const lastKey = !key
   if (lastKey) {
@@ -28,25 +29,30 @@ const dotGet = function (arrayObject, dotNotation) {
   if (key === '*') {
     const result = []
     for (const wildKey in arrayObject) {
+      // @ts-ignore
       const wildValue = arrayObject[wildKey]
       if (lastKey) {
+        // @ts-ignore
         result[wildKey] = wildValue
         continue
       }
       if (!(0, _isObject.default)(wildValue)) {
         continue
       }
+      // @ts-ignore
       result[wildKey] = dotGet(wildValue, (0, _strAfter.default)(dotNotation, '.'), defaultValue)
     }
     return result
   }
   if (lastKey) {
-    var _arrayObject$dotNotat
-    return (_arrayObject$dotNotat = arrayObject[dotNotation]) !== null && _arrayObject$dotNotat !== void 0 ? _arrayObject$dotNotat : defaultValue
+    // @ts-ignore
+    return (_a = arrayObject[dotNotation]) !== null && _a !== void 0 ? _a : defaultValue
   }
+  // @ts-ignore
   if (typeof arrayObject[key] === 'undefined') {
     return defaultValue
   }
+  // @ts-ignore
   const next = arrayObject[key]
   if (!(0, _isObject.default)(next)) {
     return defaultValue

package/dist/helpers/objects/dotGet.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _isObject=_interopRequireDefault(require("./isObject")),_strAfter=_interopRequireDefault(require("../strings/strAfter")),_strBefore=_interopRequireDefault(require("../strings/strBefore"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const dotGet=function(e,t){let r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:null,u=(0,_strBefore.default)(t,".");const i=!u;if(i&&(u=t),"*"===u){const u=[];for(let o in e){const s=e[o];i?u[o]=s:(0,_isObject.default)(s)&&(u[o]=dotGet(s,(0,_strAfter.default)(t,"."),r))}return u}var o;if(i)return null!==(o=e[t])&&void 0!==o?o:r;if(void 0===e[u])return r;const s=e[u];return(0,_isObject.default)(s)?dotGet(s,(0,_strAfter.default)(t,"."),r):r};var _default=dotGet;exports.default=_default;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _isObject=_interopRequireDefault(require("./isObject")),_strAfter=_interopRequireDefault(require("../strings/strAfter")),_strBefore=_interopRequireDefault(require("../strings/strBefore"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const dotGet=function(e,t){let r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:null;var u;let i=(0,_strBefore.default)(t,".");const o=!i;if(o&&(i=t),"*"===i){const u=[];for(let i in e){const s=e[i];o?u[i]=s:(0,_isObject.default)(s)&&(u[i]=dotGet(s,(0,_strAfter.default)(t,"."),r))}return u}if(o)return null!==(u=e[t])&&void 0!==u?u:r;if(void 0===e[i])return r;const s=e[i];return(0,_isObject.default)(s)?dotGet(s,(0,_strAfter.default)(t,"."),r):r};var _default=dotGet;exports.default=_default;

package/dist/helpers/objects/dotNotate.js

@@ -10,18 +10,6 @@ require('core-js/modules/es.string.replace.js')
 require('core-js/stable')
 var _isObject = _interopRequireDefault(require('./isObject'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
-/**
- * A string representing the full-path to a property in an object. Each depth of the path is separated by a period.
- * @example 'a.b.c'
- * @typedef {string} DotNotationString
- * @memberOf module:objectHelpers
- */
-
-/**
- * An array or object where all properties have been flatted and keyed by a dot-notated string.
- * @typedef {Object.<DotNotationString, *>} DotNotatedObject
- * @memberOf module:objectHelpers
- */
 /**
  * Convert an array of keys into a regex, return a function to test if incoming keys match.
  * @inner
@@ -29,13 +17,14 @@ function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { d
  * @param {Array.<DotNotationString>} [retainObjects=[]] - An array of keys to retain as objects
  * @returns {Function} The dot-notated array
  */
-const handleRetainObjects = retainObjects => {
+const handleRetainObjects = function () {
+  let retainObjects = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : []
   if (!retainObjects.length) {
     /**
      * Bypass the test function if there are no retainObjects.
      * @returns {false}
      */
-    return () => false
+    return (currentKey, value, results) => false
   }
   retainObjects = retainObjects.map(key => key.replace('\.', '\\.'))
   const retainRegex = new RegExp('('.concat(retainObjects.join('|'), ')$'))
@@ -50,11 +39,11 @@ const handleRetainObjects = retainObjects => {
     if (!currentKey.match(retainRegex)) {
       return false
     }
+    // @ts-ignore
     results[currentKey] = value
     return true
   }
 }
-
 /**
  * The underlying logic function for converting arrays to dot-notation.
  * @inner
@@ -68,7 +57,9 @@ const handleRetainObjects = retainObjects => {
 const performDotNotate = function (arrayObject, didRetain) {
   const prepend = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : ''
   const results = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {}
+  // @ts-ignore
   for (const key in arrayObject) {
+    // @ts-ignore
     const value = arrayObject[key]
     const currentKey = ''.concat(prepend).concat(key)
     if (didRetain(currentKey, value, results)) {
@@ -82,7 +73,6 @@ const performDotNotate = function (arrayObject, didRetain) {
   }
   return results
 }
-
 /**
  * Convert an array or object to a single dimensional associative array with dot notation.
  * @function

package/dist/helpers/objects/dotNotate.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/modules/esnext.async-iterator.map.js"),require("core-js/modules/esnext.iterator.map.js"),require("core-js/modules/es.string.replace.js"),require("core-js/stable");var _isObject=_interopRequireDefault(require("./isObject"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const handleRetainObjects=e=>{if(!e.length)return()=>!1;e=e.map((e=>e.replace(".","\\.")));const t=new RegExp("(".concat(e.join("|"),")$"));return(e,r,o)=>!!e.match(t)&&(o[e]=r,!0)},performDotNotate=function(e,t){let r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:"",o=arguments.length>3&&void 0!==arguments[3]?arguments[3]:{};for(let n in e){const a=e[n],s="".concat(r).concat(n);t(s,a,o)||((0,_isObject.default)(a)?performDotNotate(a,t,"".concat(s,"."),o):o[s]=a)}return o},dotNotate=function(e){return performDotNotate(e,handleRetainObjects(arguments.length>1&&void 0!==arguments[1]?arguments[1]:[]))};var _default=dotNotate;exports.default=_default;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/modules/esnext.async-iterator.map.js"),require("core-js/modules/esnext.iterator.map.js"),require("core-js/modules/es.string.replace.js"),require("core-js/stable");var _isObject=_interopRequireDefault(require("./isObject"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const handleRetainObjects=function(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[];if(!e.length)return(e,t,r)=>!1;e=e.map((e=>e.replace(".","\\.")));const t=new RegExp("(".concat(e.join("|"),")$"));return(e,r,o)=>!!e.match(t)&&(o[e]=r,!0)},performDotNotate=function(e,t){let r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:"",o=arguments.length>3&&void 0!==arguments[3]?arguments[3]:{};for(let n in e){const a=e[n],i="".concat(r).concat(n);t(i,a,o)||((0,_isObject.default)(a)?performDotNotate(a,t,"".concat(i,"."),o):o[i]=a)}return o},dotNotate=function(e){return performDotNotate(e,handleRetainObjects(arguments.length>1&&void 0!==arguments[1]?arguments[1]:[]))};var _default=dotNotate;exports.default=_default;

package/dist/helpers/objects/dotSet.js

@@ -19,8 +19,8 @@ function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { d
  * @returns {Object} The modified object
  */
 const dotSet = function (arrayObject, dotNotation) {
-  var _arrayObject$key
   const value = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null
+  var _a
   let key = (0, _strBefore.default)(dotNotation, '.')
   const lastKey = !key
   if (lastKey) {
@@ -29,21 +29,27 @@ const dotSet = function (arrayObject, dotNotation) {
   if (key === '*') {
     for (const wildKey in arrayObject) {
       if (lastKey) {
+        // @ts-ignore
         arrayObject[wildKey] = value
         continue
       }
+      // @ts-ignore
       if (!(0, _isObject.default)(arrayObject[wildKey])) {
         continue
       }
+      // @ts-ignore
       dotSet(arrayObject[wildKey], (0, _strAfter.default)(dotNotation, '.'), value)
     }
     return arrayObject
   }
   if (lastKey) {
+    // @ts-ignore
     arrayObject[dotNotation] = value
     return arrayObject
   }
-  const next = (_arrayObject$key = arrayObject[key]) !== null && _arrayObject$key !== void 0 ? _arrayObject$key : []
+  // @ts-ignore
+  const next = (_a = arrayObject[key]) !== null && _a !== void 0 ? _a : []
+  // @ts-ignore
   arrayObject[key] = dotSet(next, (0, _strAfter.default)(dotNotation, '.'), value)
   return arrayObject
 }

package/dist/helpers/objects/dotSet.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _isObject=_interopRequireDefault(require("./isObject")),_strAfter=_interopRequireDefault(require("../strings/strAfter")),_strBefore=_interopRequireDefault(require("../strings/strBefore"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const dotSet=function(e,t){var r;let u=arguments.length>2&&void 0!==arguments[2]?arguments[2]:null,i=(0,_strBefore.default)(t,".");const o=!i;if(o&&(i=t),"*"===i){for(let r in e)o?e[r]=u:(0,_isObject.default)(e[r])&&dotSet(e[r],(0,_strAfter.default)(t,"."),u);return e}if(o)return e[t]=u,e;const f=null!==(r=e[i])&&void 0!==r?r:[];return e[i]=dotSet(f,(0,_strAfter.default)(t,"."),u),e};var _default=dotSet;exports.default=_default;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _isObject=_interopRequireDefault(require("./isObject")),_strAfter=_interopRequireDefault(require("../strings/strAfter")),_strBefore=_interopRequireDefault(require("../strings/strBefore"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const dotSet=function(e,t){let r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:null;var u;let i=(0,_strBefore.default)(t,".");const o=!i;if(o&&(i=t),"*"===i){for(let u in e)o?e[u]=r:(0,_isObject.default)(e[u])&&dotSet(e[u],(0,_strAfter.default)(t,"."),r);return e}if(o)return e[t]=r,e;const f=null!==(u=e[i])&&void 0!==u?u:[];return e[i]=dotSet(f,(0,_strAfter.default)(t,"."),r),e};var _default=dotSet;exports.default=_default;

package/dist/helpers/objects/dotUnset.js

@@ -18,7 +18,7 @@ function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { d
  * @returns {Object} The modified object
  */
 const dotUnset = (arrayObject, dotNotation) => {
-  var _arrayObject$key
+  var _a
   let key = (0, _strBefore.default)(dotNotation, '.')
   const lastKey = !key
   if (lastKey) {
@@ -27,21 +27,27 @@ const dotUnset = (arrayObject, dotNotation) => {
   if (key === '*') {
     for (const wildKey in arrayObject) {
       if (lastKey) {
+        // @ts-ignore
         delete arrayObject[wildKey]
         continue
       }
+      // @ts-ignore
       if (!(0, _isObject.default)(arrayObject[wildKey])) {
         continue
       }
+      // @ts-ignore
       dotUnset(arrayObject[wildKey], (0, _strAfter.default)(dotNotation, '.'))
     }
     return arrayObject
   }
   if (lastKey) {
+    // @ts-ignore
     delete arrayObject[dotNotation]
     return arrayObject
   }
-  const next = (_arrayObject$key = arrayObject[key]) !== null && _arrayObject$key !== void 0 ? _arrayObject$key : []
+  // @ts-ignore
+  const next = (_a = arrayObject[key]) !== null && _a !== void 0 ? _a : []
+  // @ts-ignore
   arrayObject[key] = dotUnset(next, (0, _strAfter.default)(dotNotation, '.'))
   return arrayObject
 }

package/dist/helpers/objects/emptyObject.js

@@ -8,12 +8,12 @@ require('core-js/stable')
 var _isObject = _interopRequireDefault(require('./isObject'))
 var _objectKeys = _interopRequireDefault(require('./objectKeys'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
-/**
- * Helper function for testing if the item is an Object or Array that does not have any properties
- * @function
- * @memberOf module:objectHelpers
- * @param {Object|Array} item - Object or Array to test
- * @returns {boolean}
+/**
+ * Helper function for testing if the item is an Object or Array that does not have any properties
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} item - Object or Array to test
+ * @returns {boolean}
  */
 const emptyObject = item => (typeof item === 'function' || (0, _isObject.default)(item)) && !(0, _objectKeys.default)(item).length
 var _default = emptyObject

package/dist/helpers/objects/filterObject.js

@@ -13,26 +13,16 @@ require('core-js/stable')
 var _callWithParams = _interopRequireDefault(require('../functions/callWithParams'))
 var _objectKeys = _interopRequireDefault(require('./objectKeys'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
-/**
- * Function is a predicate, to test each property value of the object. Return true to keep the element, false
- * otherwise, taking three arguments
- * @callback module:objectHelpers~filterCallback
- * @memberOf module:objectHelpers
- * @param {*} currentProperty - The current property being processed in the object.
- * @param {string} [currentIndex] - The property name of the current property being processed in the object.
- * @param {Object|Array} [object] - The object filter was called upon.
- * @returns {boolean}
- */
-/**
- * This function is intended to replicate behaviour of the Array.filter() function but for Objects.
- * If an array is passed in instead then it will perform standard filter(). It is recommended to
- * always use the standard filter() function when it is known that the object is actually an array.
- * @function
- * @memberOf module:objectHelpers
- * @param {Object|Array} obj - The Object (or Array) to be filtered
- * @param {module:objectHelpers~filterCallback|Function} fn - The function to be processed for each filtered property
- * @param {Object|Array} [thisArg] - Optional. Value to use as this when executing callback.
- * @returns {Object|Array}
+/**
+ * This function is intended to replicate behaviour of the Array.filter() function but for Objects.
+ * If an array is passed in instead then it will perform standard filter(). It is recommended to
+ * always use the standard filter() function when it is known that the object is actually an array.
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} obj - The Object (or Array) to be filtered
+ * @param {module:objectHelpers~filterCallback|Function} fn - The function to be processed for each filtered property
+ * @param {Object|Array} [thisArg] - Optional. Value to use as this when executing callback.
+ * @returns {Object|Array}
  */
 const filterObject = function (obj, fn) {
   const thisArg = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : undefined

package/dist/helpers/objects/isCloneable.js

@@ -7,12 +7,12 @@ exports.default = void 0
 require('core-js/stable')
 var _isInstanceObject = _interopRequireDefault(require('./isInstanceObject'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
-/**
- * Determine if the value is a reference instance
- * @function
- * @memberOf module:objectHelpers
- * @param {Array|Object|*} value
- * @returns {boolean}
+/**
+ * Determine if the value is a reference instance
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Array|Object|*} value
+ * @returns {boolean}
  */
 const isCloneable = value => typeof value === 'object' && value !== null && !(0, _isInstanceObject.default)(value)
 var _default = isCloneable

package/dist/helpers/objects/isInstanceObject.js

@@ -8,12 +8,12 @@ require('core-js/stable')
 var _isObject = _interopRequireDefault(require('./isObject'))
 var _objectKeys = _interopRequireDefault(require('./objectKeys'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
-/**
- * Check if the current object has inherited properties.
- * @function
- * @memberOf module:objectHelpers
- * @param {Object|Array} object
- * @returns {boolean}
+/**
+ * Check if the current object has inherited properties.
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} object
+ * @returns {boolean}
  */
 const isInstanceObject = object => {
   if (typeof object !== 'function' && !(0, _isObject.default)(object)) {

package/dist/helpers/objects/isObject.js

@@ -5,12 +5,12 @@ Object.defineProperty(exports, '__esModule', {
 })
 exports.default = void 0
 require('core-js/stable')
-/**
- * Check if the provided thing is an object / array.
- * @function
- * @memberOf module:objectHelpers
- * @param {*} object
- * @returns {boolean}
+/**
+ * Check if the provided thing is an object / array.
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {*} object
+ * @returns {boolean}
  */
 const isObject = object => typeof object === 'object' && object !== null
 var _default = isObject

package/dist/helpers/objects/mapObject.js

@@ -14,25 +14,16 @@ var _callWithParams = _interopRequireDefault(require('../functions/callWithParam
 var _objectKeys = _interopRequireDefault(require('./objectKeys'))
 var _setValue = _interopRequireDefault(require('./setValue'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
-/**
- * Function that produces a property of the new Object, taking three arguments
- * @callback module:objectHelpers~mapCallback
- * @memberOf module:objectHelpers
- * @param {*} currentProperty - The current property being processed in the object.
- * @param {string} [currentIndex] - The property name of the current property being processed in the object.
- * @param {Object|Array} [object] - The object map was called upon.
- * @returns {*}
- */
-/**
- * This function is intended to replicate behaviour of the Array.map() function but for Objects.
- * If an array is passed in instead then it will perform standard map(). It is recommended to
- * always use the standard map() function when it is known that the object is actually an array.
- * @function
- * @memberOf module:objectHelpers
- * @param {Object|Array} obj - The Object (or Array) to be mapped
- * @param {module:objectHelpers~mapCallback|Function} fn - The function to be processed for each mapped property
- * @param {Object|Array} [thisArg] - Optional. Value to use as this when executing callback.
- * @returns {Object|Array}
+/**
+ * This function is intended to replicate behaviour of the Array.map() function but for Objects.
+ * If an array is passed in instead then it will perform standard map(). It is recommended to
+ * always use the standard map() function when it is known that the object is actually an array.
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} obj - The Object (or Array) to be mapped
+ * @param {module:objectHelpers~mapCallback|Function} fn - The function to be processed for each mapped property
+ * @param {Object|Array} [thisArg] - Optional. Value to use as this when executing callback.
+ * @returns {Object|Array}
  */
 const mapObject = function (obj, fn) {
   const thisArg = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : undefined

package/dist/helpers/objects/mergeObjects.js

@@ -7,13 +7,13 @@ exports.default = void 0
 require('core-js/stable')
 var _mergeObjectsBase = _interopRequireDefault(require('./mergeObjectsBase'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
-/**
- * Uses mergeObjectsBase deep merge objects and arrays, merge by value.
- * @function
- * @memberOf module:objectHelpers
- * @see {@link module:objectHelpers~mergeObjectsCallback}
- * @param {...Object} objects - Provide a list of objects which will be merged starting from the end up into the first
- * @returns {*}
+/**
+ * Uses mergeObjectsBase deep merge objects and arrays, merge by value.
+ * @function
+ * @memberOf module:objectHelpers
+ * @see {@link module:objectHelpers~mergeObjectsCallback}
+ * @param {...Object} objects - Provide a list of objects which will be merged starting from the end up into the first
+ * @returns {*}
  */
 const mergeObjects = (0, _mergeObjectsBase.default)({
   useClone: true

package/dist/helpers/objects/mergeObjectsBase.js

@@ -12,32 +12,25 @@ require('core-js/modules/esnext.iterator.reduce.js')
 require('core-js/modules/esnext.async-iterator.find.js')
 require('core-js/modules/esnext.iterator.find.js')
 require('core-js/stable')
-var _isCloneable = _interopRequireDefault(require('./isCloneable.js'))
-var _reduceObject = _interopRequireDefault(require('./reduceObject.js'))
-var _relevancyFilter = _interopRequireDefault(require('../functions/relevancyFilter.js'))
-var _setValue = _interopRequireDefault(require('./setValue.js'))
+var _isCloneable = _interopRequireDefault(require('./isCloneable'))
+var _reduceObject = _interopRequireDefault(require('./reduceObject'))
+var _relevancyFilter = _interopRequireDefault(require('../functions/relevancyFilter'))
+var _setValue = _interopRequireDefault(require('./setValue'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
-/**
- * Function that takes one or more objects and combines them into one.
- * @typedef {Function} module:objectHelpers~mergeObjectsCallback
- * @memberOf module:objectHelpers
- * @param {...Object} objects - Provide a list of objects which will be merged starting from the end up into the first
- * @returns {*}
- */
-/**
- * Perform a deep merge of objects. This will return a function that will combine all objects and sub-objects.
- * Objects having the same attributes will overwrite from last object to first.
- * NOTE: Use the mapLimit and relevancyRange to resolve "too much recursion" when the object is large and is known to
- * have circular references. A high mapLimit may lead to heavy memory usage and slow performance.
- * @function
- * @memberOf module:objectHelpers
- * @param {Object} [options={}]
- * @param {number} [options.mapLimit=100] - Size of temporary reference array used in memory before assessing relevancy.
- * @param {number} [options.depthLimit=-1] - Control how many nested levels deep will be used, -1 = no limit, >-1 = nth level limited.
- * @param {number} [options.relevancyRange=1000] - Total reference map length subtract this range, any relevancy less than that amount at time of evaluation will be removed.
- * @param {Iterable|array} [options.map=[]] - A predetermined list of references gathered (to be passed to itself during recursion).
- * @param {boolean} [options.useClone=false]
- * @returns {module:objectHelpers~mergeObjectsCallback}
+/**
+ * Perform a deep merge of objects. This will return a function that will combine all objects and sub-objects.
+ * Objects having the same attributes will overwrite from last object to first.
+ * NOTE: Use the mapLimit and relevancyRange to resolve "too much recursion" when the object is large and is known to
+ * have circular references. A high mapLimit may lead to heavy memory usage and slow performance.
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Object} [options={}]
+ * @param {number} [options.mapLimit=100] - Size of temporary reference array used in memory before assessing relevancy.
+ * @param {number} [options.depthLimit=-1] - Control how many nested levels deep will be used, -1 = no limit, >-1 = nth level limited.
+ * @param {number} [options.relevancyRange=1000] - Total reference map length subtract this range, any relevancy less than that amount at time of evaluation will be removed.
+ * @param {Iterable|array} [options.map=[]] - A predetermined list of references gathered (to be passed to itself during recursion).
+ * @param {boolean} [options.useClone=false]
+ * @returns {module:objectHelpers~mergeObjectsCallback|mergeObjectsCallback}
  */
 const mergeObjectsBase = function () {
   let {

package/dist/helpers/objects/mergeObjectsBase.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/modules/esnext.async-iterator.map.js"),require("core-js/modules/esnext.iterator.map.js"),require("core-js/modules/esnext.async-iterator.reduce.js"),require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.reduce.js"),require("core-js/modules/esnext.async-iterator.find.js"),require("core-js/modules/esnext.iterator.find.js"),require("core-js/stable");var _isCloneable=_interopRequireDefault(require("./isCloneable.js")),_reduceObject=_interopRequireDefault(require("./reduceObject.js")),_relevancyFilter=_interopRequireDefault(require("../functions/relevancyFilter.js")),_setValue=_interopRequireDefault(require("./setValue.js"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const mergeObjectsBase=function(){let{mapLimit:e=100,depthLimit:r=-1,relevancyRange:t=1e3,map:u=[],useClone:a=!1}=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};return function(){for(var s=arguments.length,l=new Array(s),i=0;i<s;i++)l[i]=arguments[i];const n=a?Array.isArray(l[0])?[]:{}:l.shift();return l.length<1||0===r?n:l.reduce(((s,l)=>l?(u.push({source:l,object:s,relevance:u.length}),u=(0,_relevancyFilter.default)(u,{mapLimit:e,relevancyRange:t}),(0,_reduceObject.default)(l,((l,i,n)=>{if((0,_isCloneable.default)(i)){let o=s[n];const c=u.find((e=>e.source===i));if(c)return c.relevance=u.length+1,(0,_setValue.default)(n,c.object,l);if((0,_isCloneable.default)(o)&&o||(o=a?Array.isArray(i)?[]:{}:i),(0,_isCloneable.default)(o))return(0,_setValue.default)(n,mergeObjectsBase({mapLimit:e,depthLimit:r-1,relevancyRange:t,map:u,useClone:a})(o,i),l);u.push({source:i,object:o,relevance:u.length}),u=(0,_relevancyFilter.default)(u,{mapLimit:e,relevancyRange:t})}return(0,_setValue.default)(n,i,l)}),s)):s),n||{})}};var _default=mergeObjectsBase;exports.default=_default;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/modules/esnext.async-iterator.map.js"),require("core-js/modules/esnext.iterator.map.js"),require("core-js/modules/esnext.async-iterator.reduce.js"),require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.reduce.js"),require("core-js/modules/esnext.async-iterator.find.js"),require("core-js/modules/esnext.iterator.find.js"),require("core-js/stable");var _isCloneable=_interopRequireDefault(require("./isCloneable")),_reduceObject=_interopRequireDefault(require("./reduceObject")),_relevancyFilter=_interopRequireDefault(require("../functions/relevancyFilter")),_setValue=_interopRequireDefault(require("./setValue"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const mergeObjectsBase=function(){let{mapLimit:e=100,depthLimit:r=-1,relevancyRange:t=1e3,map:u=[],useClone:a=!1}=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};return function(){for(var s=arguments.length,l=new Array(s),i=0;i<s;i++)l[i]=arguments[i];const n=a?Array.isArray(l[0])?[]:{}:l.shift();return l.length<1||0===r?n:l.reduce(((s,l)=>l?(u.push({source:l,object:s,relevance:u.length}),u=(0,_relevancyFilter.default)(u,{mapLimit:e,relevancyRange:t}),(0,_reduceObject.default)(l,((l,i,n)=>{if((0,_isCloneable.default)(i)){let o=s[n];const c=u.find((e=>e.source===i));if(c)return c.relevance=u.length+1,(0,_setValue.default)(n,c.object,l);if((0,_isCloneable.default)(o)&&o||(o=a?Array.isArray(i)?[]:{}:i),(0,_isCloneable.default)(o))return(0,_setValue.default)(n,mergeObjectsBase({mapLimit:e,depthLimit:r-1,relevancyRange:t,map:u,useClone:a})(o,i),l);u.push({source:i,object:o,relevance:u.length}),u=(0,_relevancyFilter.default)(u,{mapLimit:e,relevancyRange:t})}return(0,_setValue.default)(n,i,l)}),s)):s),n||{})}};var _default=mergeObjectsBase;exports.default=_default;

package/dist/helpers/objects/mergeObjectsMutable.js

@@ -7,13 +7,13 @@ exports.default = void 0
 require('core-js/stable')
 var _mergeObjectsBase = _interopRequireDefault(require('./mergeObjectsBase'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
-/**
- * Uses mergeObjectsBase deep merge objects and arrays, merge by reference.
- * @function
- * @memberOf module:objectHelpers
- * @see {@link module:objectHelpers~mergeObjectsCallback}
- * @param {...Object} objects - Provide a list of objects which will be merged starting from the end up into the first
- * @returns {*}
+/**
+ * Uses mergeObjectsBase deep merge objects and arrays, merge by reference.
+ * @function
+ * @memberOf module:objectHelpers
+ * @see {@link module:objectHelpers~mergeObjectsCallback}
+ * @param {...Object} objects - Provide a list of objects which will be merged starting from the end up into the first
+ * @returns {*}
  */
 const mergeObjectsMutable = (0, _mergeObjectsBase.default)()
 var _default = mergeObjectsMutable