si-funciona 1.0.0 → 1.0.1

package/README.md

@@ -234,18 +234,18 @@ Uses mergeObjectsBase deep merge objects and arrays, merge by reference.
 <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.
+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> | 
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [options] | <code>Object</code> | <code>{}</code> |  |
+| [options.mapLimit] | <code>number</code> | <code>100</code> | Size of temporary reference array used in memory before assessing relevancy. |
+| [options.depthLimit] | <code>number</code> | <code>-1</code> | Control how many nested levels deep will be used, -1 = no limit, >-1 = nth level limited. |
+| [options.relevancyRange] | <code>number</code> | <code>1000</code> | Total reference map length subtract this range, any relevancy less than that amount at time of evaluation will be removed. |
+| [options.map] | <code>Iterable</code> \| <code>array</code> | <code>[]</code> | A predetermined list of references gathered (to be passed to itself during recursion). |
+| [options.useClone] | <code>boolean</code> | <code>false</code> |  |
 
 <a name="module_objectHelpers.mergeObjects"></a>
 
@@ -386,7 +386,7 @@ Get a nested property value from an object.
 <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.
+Clone objects for manipulation without data corruption, returns a copy of the provided object.
 
 **Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
 
@@ -394,10 +394,9 @@ Clone objects for manipulation without data corruption, returns a copy of the pr
 | --- | --- | --- | --- |
 | 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> |  |
+| [options.mapLimit] | <code>number</code> | <code>100</code> | Size of temporary reference array used in memory before assessing relevancy. |
+| [options.depthLimit] | <code>number</code> | <code>-1</code> | Control how many nested levels deep will be used, -1 = no limit, >-1 = nth level limited. |
+| [options.relevancyRange] | <code>number</code> | <code>1000</code> | Total reference map length subtract this range, any relevancy less than that amount at time of evaluation will be removed. |
 
 <a name="module_objectHelpers.DotNotationString"></a>
 

package/browser/siFunciona.js

@@ -1890,22 +1890,20 @@
       value: true
     })
     exports.default = void 0
-    require('core-js/modules/es.array.map.js')
-    require('core-js/modules/esnext.async-iterator.map.js')
-    require('core-js/modules/esnext.iterator.map.js')
     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=1000]
- * @param {number} [options.depthLimit=-1]
- * @param {number} [options.relevancyRange=100]
- * @param {Iterable} [options.map=[]]
+ * @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}
  */
     var cloneObject = function cloneObject (object) {
@@ -1915,20 +1913,17 @@
       var _ref$depthLimit = _ref.depthLimit
       var depthLimit = _ref$depthLimit === void 0 ? -1 : _ref$depthLimit
       var _ref$relevancyRange = _ref.relevancyRange
-      var relevancyRange = _ref$relevancyRange === void 0 ? 100 : _ref$relevancyRange
-      var _ref$map = _ref.map
-      var map = _ref$map === void 0 ? [] : _ref$map
+      var relevancyRange = _ref$relevancyRange === void 0 ? 1000 : _ref$relevancyRange
       return (0, _mergeObjectsBase.default)({
         mapLimit: mapLimit,
         depthLimit: depthLimit,
         relevancyRange: relevancyRange,
-        map: map,
         useClone: true
       })(object)
     }
     var _default = cloneObject
     exports.default = _default
-  }, { './mergeObjectsBase': 51, 'core-js/modules/es.array.map.js': 343, 'core-js/modules/es.object.define-property.js': 417, 'core-js/modules/esnext.async-iterator.map.js': 579, 'core-js/modules/esnext.iterator.map.js': 587, 'core-js/stable': 612 }],
+  }, { './mergeObjectsBase': 51, 'core-js/modules/es.object.define-property.js': 417, 'core-js/stable': 612 }],
   40: [function (require, module, exports) {
     'use strict'
 
@@ -2496,24 +2491,26 @@
     /**
  * 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=1000]
- * @param {number} [options.depthLimit=-1]
- * @param {number} [options.relevancyRange=100]
- * @param {Iterable|array} [options.map=[]]
+ * @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}
  */
     var mergeObjectsBase = function mergeObjectsBase () {
       var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {}
       var _ref$mapLimit = _ref.mapLimit
-      var mapLimit = _ref$mapLimit === void 0 ? 1000 : _ref$mapLimit
+      var mapLimit = _ref$mapLimit === void 0 ? 100 : _ref$mapLimit
       var _ref$depthLimit = _ref.depthLimit
       var depthLimit = _ref$depthLimit === void 0 ? -1 : _ref$depthLimit
       var _ref$relevancyRange = _ref.relevancyRange
-      var relevancyRange = _ref$relevancyRange === void 0 ? 100 : _ref$relevancyRange
+      var relevancyRange = _ref$relevancyRange === void 0 ? 1000 : _ref$relevancyRange
       var _ref$map = _ref.map
       var map = _ref$map === void 0 ? [] : _ref$map
       var _ref$useClone = _ref.useClone