si-funciona 2.6.1 → 2.6.2

package/dist/helpers/objects/isEqual.d.ts

@@ -1,17 +1,17 @@
-/**
- * Check whether two values are equal by value, however they are stored: two separately made arrays or objects with the
- * same contents are equal, while two references only need to be the same when the value is a function.
- * - Primitives are equal when they are the same value (and NaN equals NaN)
- * - Arrays are equal when they have the same elements in the same order
- * - Objects are equal when they have the same prototype (the same kind of object) and the same own properties with
- * equal values, the order of the properties does not matter
- * - Dates, regular expressions, Maps and Sets are compared by what they hold
- * - Circular references are handled: a pair of objects which is already being compared is taken to be equal
- * @memberOf module:objectHelpers
- * @param {*} first - The first value.
- * @param {*} second - The second value.
- * @returns {boolean} True when the values are equal.
- */
-declare const isEqual: (first: any, second: any) => boolean;
-export default isEqual;
+/**
+ * Check whether two values are equal by value, however they are stored: two separately made arrays or objects with the
+ * same contents are equal, while two references only need to be the same when the value is a function.
+ * - Primitives are equal when they are the same value (and NaN equals NaN)
+ * - Arrays are equal when they have the same elements in the same order
+ * - Objects are equal when they have the same prototype (the same kind of object) and the same own properties with
+ * equal values, the order of the properties does not matter
+ * - Dates, regular expressions, Maps and Sets are compared by what they hold
+ * - Circular references are handled: a pair of objects which is already being compared is taken to be equal
+ * @memberOf module:objectHelpers
+ * @param {*} first - The first value.
+ * @param {*} second - The second value.
+ * @returns {boolean} True when the values are equal.
+ */
+declare const isEqual: (first: any, second: any) => boolean;
+export default isEqual;
 //# sourceMappingURL=isEqual.d.ts.map

package/dist/helpers/objects/isEqual.js

@@ -1,100 +1,100 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/modules/es.regexp.flags.js')
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.every.js')
-require('core-js/modules/esnext.iterator.some.js')
-require('core-js/modules/esnext.map.delete-all.js')
-require('core-js/modules/esnext.map.every.js')
-require('core-js/modules/esnext.map.filter.js')
-require('core-js/modules/esnext.map.find.js')
-require('core-js/modules/esnext.map.find-key.js')
-require('core-js/modules/esnext.map.includes.js')
-require('core-js/modules/esnext.map.key-of.js')
-require('core-js/modules/esnext.map.map-keys.js')
-require('core-js/modules/esnext.map.map-values.js')
-require('core-js/modules/esnext.map.merge.js')
-require('core-js/modules/esnext.map.reduce.js')
-require('core-js/modules/esnext.map.some.js')
-require('core-js/modules/esnext.map.update.js')
-require('core-js/modules/esnext.set.add-all.js')
-require('core-js/modules/esnext.set.delete-all.js')
-require('core-js/modules/esnext.set.difference.js')
-require('core-js/modules/esnext.set.every.js')
-require('core-js/modules/esnext.set.filter.js')
-require('core-js/modules/esnext.set.find.js')
-require('core-js/modules/esnext.set.intersection.js')
-require('core-js/modules/esnext.set.is-disjoint-from.js')
-require('core-js/modules/esnext.set.is-subset-of.js')
-require('core-js/modules/esnext.set.is-superset-of.js')
-require('core-js/modules/esnext.set.join.js')
-require('core-js/modules/esnext.set.map.js')
-require('core-js/modules/esnext.set.reduce.js')
-require('core-js/modules/esnext.set.some.js')
-require('core-js/modules/esnext.set.symmetric-difference.js')
-require('core-js/modules/esnext.set.union.js')
-require('core-js/modules/esnext.weak-map.delete-all.js')
-require('core-js/modules/esnext.weak-set.add-all.js')
-require('core-js/modules/esnext.weak-set.delete-all.js')
-const sameValueZero = (first, second) => first === second || first !== first && second !== second
-const compare = (first, second, seen) => {
-  if (sameValueZero(first, second)) {
-    return true
-  }
-  if (typeof first !== 'object' || typeof second !== 'object' || first === null || second === null) {
-    // Different primitives, or a function (which is only equal to itself), or an object against a primitive
-    return false
-  }
-  if (Object.getPrototypeOf(first) !== Object.getPrototypeOf(second)) {
-    return false
-  }
-  // A pair which is already being compared further up is not a difference (this is what makes circular references work)
-  const comparing = seen.get(first)
-  if (comparing && comparing.has(second)) {
-    return true
-  }
-  if (comparing) {
-    comparing.add(second)
-  } else {
-    seen.set(first, new WeakSet([second]))
-  }
-  if (first instanceof Date) {
-    return first.getTime() === second.getTime()
-  }
-  if (first instanceof RegExp) {
-    return first.source === second.source && first.flags === second.flags
-  }
-  if (first instanceof Map) {
-    return first.size === second.size && Array.from(first.entries()).every(([key, value]) => second.has(key) && compare(value, second.get(key), seen))
-  }
-  if (first instanceof Set) {
-    const others = Array.from(second.values())
-    return first.size === second.size && Array.from(first.values()).every(value => others.some(other => compare(value, other, seen)))
-  }
-  if (Array.isArray(first) && first.length !== second.length) {
-    return false
-  }
-  const firstKeys = Object.keys(first)
-  const secondKeys = Object.keys(second)
-  return firstKeys.length === secondKeys.length && firstKeys.every(key => Object.prototype.hasOwnProperty.call(second, key) && compare(first[key], second[key], seen))
-}
-/**
- * Check whether two values are equal by value, however they are stored: two separately made arrays or objects with the
- * same contents are equal, while two references only need to be the same when the value is a function.
- * - Primitives are equal when they are the same value (and NaN equals NaN)
- * - Arrays are equal when they have the same elements in the same order
- * - Objects are equal when they have the same prototype (the same kind of object) and the same own properties with
- * equal values, the order of the properties does not matter
- * - Dates, regular expressions, Maps and Sets are compared by what they hold
- * - Circular references are handled: a pair of objects which is already being compared is taken to be equal
- * @memberOf module:objectHelpers
- * @param {*} first - The first value.
- * @param {*} second - The second value.
- * @returns {boolean} True when the values are equal.
- */
-const isEqual = (first, second) => compare(first, second, new WeakMap())
-const _default = exports.default = isEqual
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/modules/es.regexp.flags.js')
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.every.js')
+require('core-js/modules/esnext.iterator.some.js')
+require('core-js/modules/esnext.map.delete-all.js')
+require('core-js/modules/esnext.map.every.js')
+require('core-js/modules/esnext.map.filter.js')
+require('core-js/modules/esnext.map.find.js')
+require('core-js/modules/esnext.map.find-key.js')
+require('core-js/modules/esnext.map.includes.js')
+require('core-js/modules/esnext.map.key-of.js')
+require('core-js/modules/esnext.map.map-keys.js')
+require('core-js/modules/esnext.map.map-values.js')
+require('core-js/modules/esnext.map.merge.js')
+require('core-js/modules/esnext.map.reduce.js')
+require('core-js/modules/esnext.map.some.js')
+require('core-js/modules/esnext.map.update.js')
+require('core-js/modules/esnext.set.add-all.js')
+require('core-js/modules/esnext.set.delete-all.js')
+require('core-js/modules/esnext.set.difference.js')
+require('core-js/modules/esnext.set.every.js')
+require('core-js/modules/esnext.set.filter.js')
+require('core-js/modules/esnext.set.find.js')
+require('core-js/modules/esnext.set.intersection.js')
+require('core-js/modules/esnext.set.is-disjoint-from.js')
+require('core-js/modules/esnext.set.is-subset-of.js')
+require('core-js/modules/esnext.set.is-superset-of.js')
+require('core-js/modules/esnext.set.join.js')
+require('core-js/modules/esnext.set.map.js')
+require('core-js/modules/esnext.set.reduce.js')
+require('core-js/modules/esnext.set.some.js')
+require('core-js/modules/esnext.set.symmetric-difference.js')
+require('core-js/modules/esnext.set.union.js')
+require('core-js/modules/esnext.weak-map.delete-all.js')
+require('core-js/modules/esnext.weak-set.add-all.js')
+require('core-js/modules/esnext.weak-set.delete-all.js')
+const sameValueZero = (first, second) => first === second || first !== first && second !== second
+const compare = (first, second, seen) => {
+  if (sameValueZero(first, second)) {
+    return true
+  }
+  if (typeof first !== 'object' || typeof second !== 'object' || first === null || second === null) {
+    // Different primitives, or a function (which is only equal to itself), or an object against a primitive
+    return false
+  }
+  if (Object.getPrototypeOf(first) !== Object.getPrototypeOf(second)) {
+    return false
+  }
+  // A pair which is already being compared further up is not a difference (this is what makes circular references work)
+  const comparing = seen.get(first)
+  if (comparing && comparing.has(second)) {
+    return true
+  }
+  if (comparing) {
+    comparing.add(second)
+  } else {
+    seen.set(first, new WeakSet([second]))
+  }
+  if (first instanceof Date) {
+    return first.getTime() === second.getTime()
+  }
+  if (first instanceof RegExp) {
+    return first.source === second.source && first.flags === second.flags
+  }
+  if (first instanceof Map) {
+    return first.size === second.size && Array.from(first.entries()).every(([key, value]) => second.has(key) && compare(value, second.get(key), seen))
+  }
+  if (first instanceof Set) {
+    const others = Array.from(second.values())
+    return first.size === second.size && Array.from(first.values()).every(value => others.some(other => compare(value, other, seen)))
+  }
+  if (Array.isArray(first) && first.length !== second.length) {
+    return false
+  }
+  const firstKeys = Object.keys(first)
+  const secondKeys = Object.keys(second)
+  return firstKeys.length === secondKeys.length && firstKeys.every(key => Object.prototype.hasOwnProperty.call(second, key) && compare(first[key], second[key], seen))
+}
+/**
+ * Check whether two values are equal by value, however they are stored: two separately made arrays or objects with the
+ * same contents are equal, while two references only need to be the same when the value is a function.
+ * - Primitives are equal when they are the same value (and NaN equals NaN)
+ * - Arrays are equal when they have the same elements in the same order
+ * - Objects are equal when they have the same prototype (the same kind of object) and the same own properties with
+ * equal values, the order of the properties does not matter
+ * - Dates, regular expressions, Maps and Sets are compared by what they hold
+ * - Circular references are handled: a pair of objects which is already being compared is taken to be equal
+ * @memberOf module:objectHelpers
+ * @param {*} first - The first value.
+ * @param {*} second - The second value.
+ * @returns {boolean} True when the values are equal.
+ */
+const isEqual = (first, second) => compare(first, second, new WeakMap())
+const _default = exports.default = isEqual

package/dist/helpers/objects/isInstanceObject.d.ts

@@ -1,9 +1,9 @@
-/**
- * Check if the current object has inherited properties.
- * @memberOf module:objectHelpers
- * @param {Object|Array} object
- * @returns {boolean}
- */
-declare const isInstanceObject: (object: Array<any> | Object) => boolean;
-export default isInstanceObject;
+/**
+ * Check if the current object has inherited properties.
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} object
+ * @returns {boolean}
+ */
+declare const isInstanceObject: (object: Array<any> | Object) => boolean;
+export default isInstanceObject;
 //# sourceMappingURL=isInstanceObject.d.ts.map

package/dist/helpers/objects/isInstanceObject.js

@@ -1,26 +1,26 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/modules/es.array.includes.js')
-const _isObject = _interopRequireDefault(require('./isObject'))
-const _objectKeys = _interopRequireDefault(require('./objectKeys'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Check if the current object has inherited properties.
- * @memberOf module:objectHelpers
- * @param {Object|Array} object
- * @returns {boolean}
- */
-const isInstanceObject = object => {
-  if (typeof object !== 'function' && !(0, _isObject.default)(object)) {
-    return false
-  }
-  if (!['Array', 'Function', 'Object'].includes(object.constructor.name)) {
-    return true
-  }
-  return object.constructor.name !== 'Array' && (0, _objectKeys.default)(object, true).length > (0, _objectKeys.default)(object).length
-}
-const _default = exports.default = isInstanceObject
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/modules/es.array.includes.js')
+const _isObject = _interopRequireDefault(require('./isObject'))
+const _objectKeys = _interopRequireDefault(require('./objectKeys'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Check if the current object has inherited properties.
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} object
+ * @returns {boolean}
+ */
+const isInstanceObject = object => {
+  if (typeof object !== 'function' && !(0, _isObject.default)(object)) {
+    return false
+  }
+  if (!['Array', 'Function', 'Object'].includes(object.constructor.name)) {
+    return true
+  }
+  return object.constructor.name !== 'Array' && (0, _objectKeys.default)(object, true).length > (0, _objectKeys.default)(object).length
+}
+const _default = exports.default = isInstanceObject

package/dist/helpers/objects/isObject.d.ts

@@ -1,9 +1,9 @@
-/**
- * Check if the provided thing is an object / array.
- * @memberOf module:objectHelpers
- * @param {*} object
- * @returns {boolean}
- */
-declare const isObject: (object: any) => boolean;
-export default isObject;
+/**
+ * Check if the provided thing is an object / array.
+ * @memberOf module:objectHelpers
+ * @param {*} object
+ * @returns {boolean}
+ */
+declare const isObject: (object: any) => boolean;
+export default isObject;
 //# sourceMappingURL=isObject.d.ts.map

package/dist/helpers/objects/isObject.js

@@ -1,14 +1,14 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-/**
- * Check if the provided thing is an object / array.
- * @memberOf module:objectHelpers
- * @param {*} object
- * @returns {boolean}
- */
-const isObject = object => typeof object === 'object' && object !== null
-const _default = exports.default = isObject
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+/**
+ * Check if the provided thing is an object / array.
+ * @memberOf module:objectHelpers
+ * @param {*} object
+ * @returns {boolean}
+ */
+const isObject = object => typeof object === 'object' && object !== null
+const _default = exports.default = isObject

package/dist/helpers/objects/mapObject.d.ts

@@ -1,26 +1,26 @@
-type mappableItem = Array<any> | {
-    [k: number | string]: any;
-};
-/**
- * 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 {*}
- */
-type mapCallback = (currentProperty: any, currentIndex: keyof mappableItem, object: mappableItem) => any;
-/**
- * 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.
- * @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}
- */
-declare const mapObject: (obj: mappableItem, fn: mapCallback, thisArg?: mappableItem) => mappableItem;
-export default mapObject;
+type mappableItem = Array<any> | {
+    [k: number | string]: any;
+};
+/**
+ * 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 {*}
+ */
+type mapCallback = (currentProperty: any, currentIndex: keyof mappableItem, object: mappableItem) => any;
+/**
+ * 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.
+ * @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}
+ */
+declare const mapObject: (obj: mappableItem, fn: mapCallback, thisArg?: mappableItem) => mappableItem;
+export default mapObject;
 //# sourceMappingURL=mapObject.d.ts.map

package/dist/helpers/objects/mapObject.js

@@ -1,25 +1,25 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.map.js')
-require('core-js/modules/esnext.iterator.reduce.js')
-const _callWithParams = _interopRequireDefault(require('../functions/callWithParams'))
-const _objectKeys = _interopRequireDefault(require('./objectKeys'))
-const _setValue = _interopRequireDefault(require('./setValue'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * 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.
- * @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 = (obj, fn, thisArg = undefined) => Array.isArray(obj) ? obj.map(fn, thisArg) : (0, _objectKeys.default)(obj, true).reduce((newObj, curr) => (0, _setValue.default)(curr, (0, _callWithParams.default)(fn.bind(thisArg), [obj[curr], curr, obj], 2), newObj), {})
-const _default = exports.default = mapObject
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.map.js')
+require('core-js/modules/esnext.iterator.reduce.js')
+const _callWithParams = _interopRequireDefault(require('../functions/callWithParams'))
+const _objectKeys = _interopRequireDefault(require('./objectKeys'))
+const _setValue = _interopRequireDefault(require('./setValue'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * 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.
+ * @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 = (obj, fn, thisArg = undefined) => Array.isArray(obj) ? obj.map(fn, thisArg) : (0, _objectKeys.default)(obj, true).reduce((newObj, curr) => (0, _setValue.default)(curr, (0, _callWithParams.default)(fn.bind(thisArg), [obj[curr], curr, obj], 2), newObj), {})
+const _default = exports.default = mapObject

package/dist/helpers/objects/mergeObjects.d.ts

@@ -1,13 +1,13 @@
-/**
- * Uses mergeObjectsBase deep merge objects and arrays, merge by value.
- * @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 {*}
- */
-declare const mergeObjects: (...objects: Array<Object>) => any[] | {
-    [k: string]: any;
-    [k: number]: any;
-};
-export default mergeObjects;
+/**
+ * Uses mergeObjectsBase deep merge objects and arrays, merge by value.
+ * @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 {*}
+ */
+declare const mergeObjects: (...objects: Array<Object>) => any[] | {
+    [k: string]: any;
+    [k: number]: any;
+};
+export default mergeObjects;
 //# sourceMappingURL=mergeObjects.d.ts.map

package/dist/helpers/objects/mergeObjects.js

@@ -1,19 +1,19 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-const _mergeObjectsBase = _interopRequireDefault(require('./mergeObjectsBase'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Uses mergeObjectsBase deep merge objects and arrays, merge by value.
- * @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
-})
-const _default = exports.default = mergeObjects
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+const _mergeObjectsBase = _interopRequireDefault(require('./mergeObjectsBase'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Uses mergeObjectsBase deep merge objects and arrays, merge by value.
+ * @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
+})
+const _default = exports.default = mergeObjects

package/dist/helpers/objects/mergeObjectsBase.d.ts

@@ -1,36 +1,36 @@
-import { relevanceMap } from '../functions/relevancyFilter';
-type mergeableItem = Array<any> | {
-    [k: number | string]: any;
-};
-/**
- * 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 {*}
- */
-type mergeObjectsCallback = (...objects: Array<Object>) => mergeableItem;
-type mergeObjectsBaseOptions = {
-    mapLimit?: number;
-    depthLimit?: number;
-    relevancyRange?: number;
-    map?: relevanceMap;
-    useClone?: boolean;
-};
-/**
- * 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.
- * @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}
- */
-declare const mergeObjectsBase: ({ mapLimit, depthLimit, relevancyRange, map, useClone, }?: mergeObjectsBaseOptions) => mergeObjectsCallback;
-export default mergeObjectsBase;
+import { relevanceMap } from '../functions/relevancyFilter';
+type mergeableItem = Array<any> | {
+    [k: number | string]: any;
+};
+/**
+ * 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 {*}
+ */
+type mergeObjectsCallback = (...objects: Array<Object>) => mergeableItem;
+type mergeObjectsBaseOptions = {
+    mapLimit?: number;
+    depthLimit?: number;
+    relevancyRange?: number;
+    map?: relevanceMap;
+    useClone?: boolean;
+};
+/**
+ * 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.
+ * @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}
+ */
+declare const mergeObjectsBase: ({ mapLimit, depthLimit, relevancyRange, map, useClone, }?: mergeObjectsBaseOptions) => mergeObjectsCallback;
+export default mergeObjectsBase;
 //# sourceMappingURL=mergeObjectsBase.d.ts.map