si-funciona 1.2.0 → 2.0.1

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.d.ts

@@ -0,0 +1,10 @@
+import 'core-js/stable';
+/**
+ * Determine if the value is a reference instance
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Array|Object|*} value
+ * @returns {boolean}
+ */
+declare const isCloneable: (value: Array<any> | Object | any) => boolean;
+export default isCloneable;

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.d.ts

@@ -0,0 +1,10 @@
+import 'core-js/stable';
+/**
+ * Check if the current object has inherited properties.
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} object
+ * @returns {boolean}
+ */
+declare const isInstanceObject: (object: Array<any> | Object) => boolean;
+export default isInstanceObject;

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.d.ts

@@ -0,0 +1,10 @@
+import 'core-js/stable';
+/**
+ * Check if the provided thing is an object / array.
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {*} object
+ * @returns {boolean}
+ */
+declare const isObject: (object: any) => boolean;
+export default isObject;

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.d.ts

@@ -0,0 +1,27 @@
+import 'core-js/stable';
+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.
+ * @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}
+ */
+declare const mapObject: (obj: mappableItem, fn: mapCallback, thisArg?: mappableItem) => mappableItem;
+export default mapObject;

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.d.ts

@@ -0,0 +1,14 @@
+import 'core-js/stable';
+/**
+ * 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 {*}
+ */
+declare const mergeObjects: (...objects: Object[]) => any[] | {
+    [k: string]: any;
+    [k: number]: any;
+};
+export default mergeObjects;

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.d.ts

@@ -0,0 +1,37 @@
+import 'core-js/stable';
+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.
+ * @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}
+ */
+declare const mergeObjectsBase: ({ mapLimit, depthLimit, relevancyRange, map, useClone, }?: mergeObjectsBaseOptions) => mergeObjectsCallback;
+export default mergeObjectsBase;

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.d.ts

@@ -0,0 +1,14 @@
+import 'core-js/stable';
+/**
+ * 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 {*}
+ */
+declare const mergeObjectsMutable: (...objects: Object[]) => any[] | {
+    [k: string]: any;
+    [k: number]: any;
+};
+export default mergeObjectsMutable;

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

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

@@ -0,0 +1,15 @@
+import 'core-js/stable';
+type keyableItem = Array<any> | {
+    [k: number | string]: any;
+};
+/**
+ * Get an array of keys from any object or array. Will return empty array when invalid or there are no keys.
+ * Optional flag will include the inherited keys from prototype chain when set.
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} object
+ * @param {boolean} [includeInherited=false]
+ * @returns {Array.<string|number>}
+ */
+declare const objectKeys: (object: keyableItem, includeInherited?: boolean) => Array<any>;
+export default objectKeys;

package/dist/helpers/objects/objectKeys.js

@@ -7,14 +7,14 @@ exports.default = void 0
 require('core-js/stable')
 var _isObject = _interopRequireDefault(require('./isObject'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
-/**
- * Get an array of keys from any object or array. Will return empty array when invalid or there are no keys.
- * Optional flag will include the inherited keys from prototype chain when set.
- * @function
- * @memberOf module:objectHelpers
- * @param {Object|Array} object
- * @param {boolean} [includeInherited=false]
- * @returns {Array.<string|number>}
+/**
+ * Get an array of keys from any object or array. Will return empty array when invalid or there are no keys.
+ * Optional flag will include the inherited keys from prototype chain when set.
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} object
+ * @param {boolean} [includeInherited=false]
+ * @returns {Array.<string|number>}
  */
 const objectKeys = function (object) {
   const includeInherited = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false

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

@@ -0,0 +1,15 @@
+import 'core-js/stable';
+type arrayObjectItem = Array<any> | {
+    [k: number | string]: any;
+};
+/**
+ * Get an array of values from any object or array. Will return empty array when invalid or there are no values.
+ * Optional flag will include the inherited values from prototype chain when set.
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} object
+ * @param {boolean} [includeInherited=false]
+ * @returns {Array}
+ */
+declare const objectValues: (object: arrayObjectItem, includeInherited?: boolean) => Array<any>;
+export default objectValues;

package/dist/helpers/objects/objectValues.js

@@ -9,14 +9,14 @@ require('core-js/modules/esnext.iterator.map.js')
 require('core-js/stable')
 var _objectKeys = _interopRequireDefault(require('./objectKeys'))
 function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
-/**
- * Get an array of values from any object or array. Will return empty array when invalid or there are no values.
- * Optional flag will include the inherited values from prototype chain when set.
- * @function
- * @memberOf module:objectHelpers
- * @param {Object|Array} object
- * @param {boolean} [includeInherited=false]
- * @returns {Array}
+/**
+ * Get an array of values from any object or array. Will return empty array when invalid or there are no values.
+ * Optional flag will include the inherited values from prototype chain when set.
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} object
+ * @param {boolean} [includeInherited=false]
+ * @returns {Array}
  */
 const objectValues = function (object) {
   const includeInherited = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false

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

@@ -0,0 +1,32 @@
+import 'core-js/stable';
+type reduceableItem = Array<any> | {
+    [k: number | string]: any;
+};
+/**
+ * Function to execute on each property in the object, taking four arguments
+ * @callback module:objectHelpers~reduceCallback
+ * @memberOf module:objectHelpers
+ * @param {*} [accumulator={}] - 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).
+ * @param {*} [currentProperty={}] - The current property being processed in the object.
+ * @param {string} [currentIndex=0] - 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.
+ * @param {Object|Array} [object={}] - The object reduce was called upon.
+ * @returns {*}
+ */
+type reduceCallback = (accumulator: any, currentProperty: any, currentIndex: keyof reduceableItem, object: reduceableItem) => any;
+/**
+ * This function is intended to replicate behaviour of the Array.reduce() function but for Objects.
+ * If an array is passed in instead then it will perform standard reduce(). It is recommended to
+ * always use the standard reduce() 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~reduceCallback|Function|reduceCallback} fn - The function to be processed for each filtered property
+ * @param {Object|Array} [initialValue] - 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.
+ * @returns {*}
+ */
+declare const reduceObject: (obj: reduceableItem, fn: reduceCallback, initialValue?: reduceableItem) => any;
+export default reduceObject;

package/dist/helpers/objects/reduceObject.js

@@ -11,30 +11,18 @@ 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 to execute on each property in the object, taking four arguments
- * @callback module:objectHelpers~reduceCallback
- * @memberOf module:objectHelpers
- * @param {*} [accumulator={}] - 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).
- * @param {*} [currentProperty={}] - The current property being processed in the object.
- * @param {string} [currentIndex=0] - 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.
- * @param {Object|Array} [object={}] - The object reduce was called upon.
- * @returns {*}
- */
-/**
- * This function is intended to replicate behaviour of the Array.reduce() function but for Objects.
- * If an array is passed in instead then it will perform standard reduce(). It is recommended to
- * always use the standard reduce() 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~reduceCallback|Function} fn - The function to be processed for each filtered property
- * @param {Object|Array} [initialValue] - 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.
- * @returns {Object|Array}
+/**
+ * This function is intended to replicate behaviour of the Array.reduce() function but for Objects.
+ * If an array is passed in instead then it will perform standard reduce(). It is recommended to
+ * always use the standard reduce() 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~reduceCallback|Function|reduceCallback} fn - The function to be processed for each filtered property
+ * @param {Object|Array} [initialValue] - 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.
+ * @returns {*}
  */
 const reduceObject = function (obj, fn) {
   const initialValue = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : obj[(0, _objectKeys.default)(obj)[0]] || obj[0]

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

@@ -0,0 +1,15 @@
+import 'core-js/stable';
+type settableItem = Array<any> | {
+    [k: number | string]: any;
+};
+/**
+ * Set a value on an item, then return the value
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} item - An object or array to be updated
+ * @param {string|number} key - The key on the item which will have its value set
+ * @param {*} value - Any value to be applied to the key
+ * @returns {*}
+ */
+declare const setAndReturnValue: (item: settableItem, key: keyof settableItem, value: any) => any;
+export default setAndReturnValue;

package/dist/helpers/objects/setAndReturnValue.js

@@ -5,14 +5,14 @@ Object.defineProperty(exports, '__esModule', {
 })
 exports.default = void 0
 require('core-js/stable')
-/**
- * Set a value on an item, then return the value
- * @function
- * @memberOf module:objectHelpers
- * @param {Object|Array} item - An object or array to be updated
- * @param {string|number} key - The key on the item which will have its value set
- * @param {*} value - Any value to be applied to the key
- * @returns {*}
+/**
+ * Set a value on an item, then return the value
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} item - An object or array to be updated
+ * @param {string|number} key - The key on the item which will have its value set
+ * @param {*} value - Any value to be applied to the key
+ * @returns {*}
  */
 const setAndReturnValue = (item, key, value) => {
   item[key] = value

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

@@ -0,0 +1,16 @@
+import 'core-js/stable';
+type settableItem = Array<any> | {
+    [k: number | string]: any;
+};
+/**
+ * Set a value on an item, then return the item.
+ * NOTE: Argument order designed for usage with pipe
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {string|number} key - The key on the item which will have its value set
+ * @param {*} value - Any value to be applied to the key
+ * @param {Object|Array} item - An object or array to be updated
+ * @returns {Object|Array}
+ */
+declare const setValue: (key: number | string, value: any, item: settableItem) => settableItem;
+export default setValue;

package/dist/helpers/objects/setValue.js

@@ -5,17 +5,18 @@ Object.defineProperty(exports, '__esModule', {
 })
 exports.default = void 0
 require('core-js/stable')
-/**
- * Set a value on an item, then return the item.
- * NOTE: Argument order designed for usage with pipe
- * @function
- * @memberOf module:objectHelpers
- * @param {string|number} key - The key on the item which will have its value set
- * @param {*} value - Any value to be applied to the key
- * @param {Object|Array} item - An object or array to be updated
- * @returns {Object|Array}
+/**
+ * Set a value on an item, then return the item.
+ * NOTE: Argument order designed for usage with pipe
+ * @function
+ * @memberOf module:objectHelpers
+ * @param {string|number} key - The key on the item which will have its value set
+ * @param {*} value - Any value to be applied to the key
+ * @param {Object|Array} item - An object or array to be updated
+ * @returns {Object|Array}
  */
 const setValue = (key, value, item) => {
+  // @ts-ignore
   item[key] = value
   return item
 }