@vanillaes/absurdum 2.0.6 → 2.0.10

package/src/arrays/zip.js

@@ -3,10 +3,11 @@
 /**
  * Zip applies a specified function to the corresponding elements of two sequences,
  * producing a sequence of the results.
- * @param {Array} arrayA input array
- * @param {Array} ArrayB input array
+ * @template T
+ * @param {T[]} arrayA input array
+ * @param {T[]} ArrayB input array
  * @param {Function} [func] to be applied to corresponding values (default (a, b)=>[a, b])
- * @returns {Array} input array filled value pairs after the function has been applied
+ * @returns {T[]} input array filled value pairs after the function has been applied
  * @example
  * const result = zip([5, 12, 8, 130, 44], ["ham", "cheese", "bread"]);
  * console.log(result)
@@ -16,21 +17,19 @@
  * console.log(result)
  * > [ 'ham 5', 'cheese 12', 'bread 8' ]
  */
-function zip (arrayA, ArrayB, func = (a, b) => [a, b]) {
+export function zip (arrayA, ArrayB, func = (/** @type {T} */ a, /** @type {T} */ b) => [a, b]) {
   if (func && typeof func !== 'function') {
     throw TypeError('func must be a function')
   }
   if (arrayA.length <= ArrayB.length) {
-    return arrayA.reduce((res, cur, i) => {
+    return arrayA.reduce((/** @type {T[]} */ res, cur, i) => {
       res[i] = func(cur, ArrayB[i])
       return res
     }, [])
   } else {
-    return ArrayB.reduce((res, cur, i) => {
+    return ArrayB.reduce((/** @type {T[]} */ res, cur, i) => {
       res[i] = func(arrayA[i], cur)
       return res
     }, [])
   }
 }
-
-export { zip }

package/src/objects/assign.d.ts

@@ -1,15 +1,13 @@
 /**
  * Assign merges object properties from all supplied objects. If a property
  * already exists, then it is overwritten when merged from left to right.
- *
  * @param {object} object input object
  * @param {...object} sources input source object(s)
  * @returns {object} returns new object
- *
  * @example
  * const someObj = { hold: 44, fast: 14 };
  * const result = objects.assign(someObj, { hold: 25, your: 19, horses: 4 });
  * console.log(result);
  * > { hold: 25, fast: 14, your: 19, horses: 4 }
  */
-export function assign(object: any, ...sources: any[]): any;
+export function assign(object: object, ...sources: object[]): object;

package/src/objects/assign.js

@@ -1,3 +1,5 @@
+// @ts-nocheck TODO: Fix types on this later
+
 /**
  * Assign merges object properties from all supplied objects. If a property
  * already exists, then it is overwritten when merged from left to right.
@@ -10,7 +12,7 @@
  * console.log(result);
  * > { hold: 25, fast: 14, your: 19, horses: 4 }
  */
-function assign (object, ...sources) {
+export function assign (object, ...sources) {
   if (arguments.length < 2) { return arguments.length === 1 ? object : {} }
   const result = [object, ...sources]
 
@@ -22,5 +24,3 @@ function assign (object, ...sources) {
     return acc
   }, {})
 }
-
-export { assign }

package/src/objects/at.d.ts

@@ -1,13 +1,11 @@
 /**
  * At, creates an array of values corresponding to paths of the object
- *
  * @param {object} object input object
  * @param {...(string|string[])} paths strings describing paths to be returned from an object
- * @returns {array} array of values found by object paths in object
- *
+ * @returns {Array} array of values found by object paths in object
  * @example
  * const result = objects.at({ a: [13, 64], ']': 'b' });
  * console.log(result, 'a[1]');
  * > [64]
  */
-export function at(object: any, ...paths: (string | string[])[]): any[];
+export function at(object: object, ...paths: (string | string[])[]): any[];

package/src/objects/at.js

@@ -1,3 +1,5 @@
+// @ts-nocheck TODO: Fix types on this later
+
 /**
  * At, creates an array of values corresponding to paths of the object
  * @param {object} object input object
@@ -8,7 +10,7 @@
  * console.log(result, 'a[1]');
  * > [64]
  */
-function at (object, ...paths) {
+export function at (object, ...paths) {
   if (paths.length === 0) { return [] }
 
   const pathArray = []
@@ -38,5 +40,3 @@ function at (object, ...paths) {
     return acc
   }, [])
 }
-
-export { at }

package/src/objects/defaults.d.ts

@@ -1,15 +1,13 @@
 /**
  * Defaults recursively merges object properties from all supplied objects. If a property
  * already exists, then the existing one is kept when merged from left to right.
- *
  * @param {object} object input object
  * @param {...object} sources input source object(s)
  * @returns {object} returns new object
- *
  * @example
  * const someObj = { hold: 44 };
  * const result = objects.defaults(someObj, { hold: 25, your: 19, horses: 4 });
  * console.log(result);
  * > { hold: 44, your: 19, horses: 4 }
  */
-export function defaults(object: any, ...sources: any[]): any;
+export function defaults(object: object, ...sources: object[]): object;

package/src/objects/defaults.js

@@ -1,3 +1,5 @@
+// @ts-nocheck TODO: Fix types on this later
+
 /**
  * Defaults recursively merges object properties from all supplied objects. If a property
  * already exists, then the existing one is kept when merged from left to right.
@@ -10,7 +12,7 @@
  * console.log(result);
  * > { hold: 44, your: 19, horses: 4 }
  */
-function defaults (object, ...sources) {
+export function defaults (object, ...sources) {
   if (arguments.length < 2) { return arguments.length === 1 ? object : {} }
   const result = [object, ...sources]
 
@@ -22,5 +24,3 @@ function defaults (object, ...sources) {
     return acc
   }, {})
 }
-
-export { defaults }

package/src/objects/defaultsDeep.d.ts

@@ -1,14 +1,12 @@
 /**
  * DefaultsDeep recursively merges object properties from all supplied objects with object values
  * being merged recursively and once a property is set, additional values of the same property are ignored.
- *
  * @param {object} object input object
  * @param {...object} sources input source object(s)
  * @returns {object} returns an object with all included object properties merged
- *
  * @example
  * const result = objects.defaultsDeep({ a: { b: [3, 4] } }, { a: { b: [9, 18, 15], c: 3 } });
  * console.log(result);
  * > { a: { b: [ 3, 4, 15 ], c: 3 } }
  */
-export function defaultsDeep(object: any, ...sources: any[]): any;
+export function defaultsDeep(object: object, ...sources: object[]): object;

package/src/objects/defaultsDeep.js

@@ -1,3 +1,5 @@
+// @ts-nocheck TODO: Fix types on this later
+
 /**
  * DefaultsDeep recursively merges object properties from all supplied objects with object values
  * being merged recursively and once a property is set, additional values of the same property are ignored.
@@ -9,7 +11,7 @@
  * console.log(result);
  * > { a: { b: [ 3, 4, 15 ], c: 3 } }
  */
-function defaultsDeep (object, ...sources) {
+export function defaultsDeep (object, ...sources) {
   if (arguments.length < 2) { return arguments.length === 1 ? object : {} }
   const result = [object, ...sources]
 
@@ -59,5 +61,3 @@ const objectMerge = (current, source) => {
   }, null)
   return res
 }
-
-export { defaultsDeep }

package/src/objects/entries.d.ts

@@ -1,12 +1,10 @@
 /**
  * Entries takes an object and returns an array composed from key-value pairs.
- *
  * @param {object} object input object
  * @returns {Array} an array composed from arrays of the key-value pairs
- *
  * @example
  * const result = objects.entries({ asuka: 643, heian: 795, meiji: 1868 });
  * console.log(result);
  * > [[asuka, 643], [heian, 795], [meiji: 1868]]
  */
-export function entries(object: any): any[];
+export function entries(object: object): any[];

package/src/objects/entries.js

@@ -1,3 +1,5 @@
+// @ts-nocheck TODO: Fix types on this later
+
 /**
  * Entries takes an object and returns an array composed from key-value pairs.
  * @param {object} object input object
@@ -7,11 +9,9 @@
  * console.log(result);
  * > [[asuka, 643], [heian, 795], [meiji: 1868]]
  */
-function entries (object) {
+export function entries (object) {
   return Object.keys(object).reduce((acc, key) => {
     acc.push([key, object[key]])
     return acc
   }, [])
 }
-
-export { entries }

package/src/objects/filter.d.ts

@@ -2,15 +2,13 @@
  * Filter iterates over an object and applies a predicate to each property, for all properties
  * where the predicate is true, return that property in a new object. Function is invoked
  * with 3 arguments (value, key, object)
- *
- * @param {Object} object input object
+ * @param {object} object input object
  * @param {Function} predicate predicate function to check what properties to include
- * @returns {Object} object with selected properties
- *
+ * @returns {object} object with selected properties
  * @example
  * const obj = { small: "ant", medium: "dog", big: "elephant" }
  * const result = objects.filter(obj, (value, key, object) => ['small', 'big'].includes(key)));
  * console.log(result);
  * > { small: "ant", big: "elephant" }
  */
-export function filter(object: any, predicate: Function): any;
+export function filter(object: object, predicate: Function): object;

package/src/objects/filter.js

@@ -1,4 +1,5 @@
 /* eslint-disable jsdoc/reject-function-type */
+// @ts-nocheck TODO: Fix types on this later
 
 /**
  * Filter iterates over an object and applies a predicate to each property, for all properties
@@ -13,7 +14,7 @@
  * console.log(result);
  * > { small: "ant", big: "elephant" }
  */
-function filter (object, predicate) {
+export function filter (object, predicate) {
   if (typeof predicate !== 'function') { return object }
   return Object.keys(object).reduce((acc, key) => {
     if (predicate(object[key], key, object) === true) {
@@ -22,5 +23,3 @@ function filter (object, predicate) {
     return acc
   }, {})
 }
-
-export { filter }

package/src/objects/findKey.d.ts

@@ -1,14 +1,12 @@
 /**
  * FindKey returns the key of the first property value for which a supplied function returns true
- *
  * @param {object} object input object
- * @param {function} [predicate=(x)=>x] function to test against object values
+ * @param {Function} [predicate] function to test against object values (default x=>x)
  * @param {*} [thisArg] value of this in a function call
  * @returns {string} string of the first object key whose value returns truthy against the function
- *
  * @example
  * const result = Objects.findKey({ apple: 34, pear: 434, orange: 4 }, x => x > 100 );
  * console.log(result);
  * > 'pear'
  */
-export function findKey(object: any, predicate?: Function, thisArg?: any): string;
+export function findKey(object: object, predicate?: Function, thisArg?: any): string;

package/src/objects/findKey.js

@@ -1,4 +1,5 @@
 /* eslint-disable jsdoc/reject-any-type,jsdoc/reject-function-type */
+// @ts-nocheck TODO: Fix types on this later
 
 /**
  * FindKey returns the key of the first property value for which a supplied function returns true
@@ -11,7 +12,7 @@
  * console.log(result);
  * > 'pear'
  */
-function findKey (object, predicate = x => x, thisArg) {
+export function findKey (object, predicate = x => x, thisArg) {
   const keys = Object.keys(object)
 
   if (typeof predicate === 'function') {
@@ -58,5 +59,3 @@ const objContained = (objA, objB) => {
     return true
   }, false)
 }
-
-export { findKey }

package/src/objects/findLastKey.d.ts

@@ -1,14 +1,12 @@
 /**
  * FindLastKey returns the key of the last property value for which a supplied function returns true
- *
  * @param {object} object input object
- * @param {function} [predicate=(x)=>x] function to test against object values
+ * @param {Function} [predicate] function to test against object values (default x=>x)
  * @param {*} [thisArg] value of this in a function call
  * @returns {string} string of the first object key whose value returns truthy against the function
- *
  * @example
  * const result = Objects.findLastKey({ apple: 34, pear: 434, orange: 4, grapefruit: 212 }, x => x > 100 );
  * console.log(result);
  * > 'grapefruit'
  */
-export function findLastKey(object: any, predicate?: Function, thisArg?: any): string;
+export function findLastKey(object: object, predicate?: Function, thisArg?: any): string;

package/src/objects/findLastKey.js

@@ -1,4 +1,5 @@
 /* eslint-disable jsdoc/reject-any-type,jsdoc/reject-function-type */
+// @ts-nocheck TODO: Fix types on this later
 
 /**
  * FindLastKey returns the key of the last property value for which a supplied function returns true
@@ -11,7 +12,7 @@
  * console.log(result);
  * > 'grapefruit'
  */
-function findLastKey (object, predicate = x => x, thisArg) {
+export function findLastKey (object, predicate = x => x, thisArg) {
   const keys = Object.keys(object)
 
   if (typeof predicate === 'function') {
@@ -58,5 +59,3 @@ const objContained = (objA, objB) => {
     return true
   }, false)
 }
-
-export { findLastKey }

package/src/objects/forIn.d.ts

@@ -1,11 +1,9 @@
 /**
  * forIn iterates over own and inherited enumerable string keyed properties of an object and invokes
  * iteratee for each property. The iteratee is invoked with three arguments: (value, key, object)
- *
- * @param {Object} object input object
+ * @param {object} object input object
  * @param {Function} func function invoked per iteration
- * @returns {Object} original object
- *
+ * @returns {object} original object
  * @example
  * const Obj_A = function () {
  *   this.a = 5;
@@ -19,4 +17,4 @@
  * // 15
  * > { a: 5, b: 10 }
  */
-export function forIn(object: any, func: Function): any;
+export function forIn(object: object, func: Function): object;

package/src/objects/forIn.js

@@ -1,4 +1,5 @@
 /* eslint-disable jsdoc/reject-function-type */
+// @ts-nocheck TODO: Fix types on this later
 
 /**
  * forIn iterates over own and inherited enumerable string keyed properties of an object and invokes
@@ -19,7 +20,7 @@
  * // 15
  * > { a: 5, b: 10 }
  */
-function forIn (object, func) {
+export function forIn (object, func) {
   const objProto = Object.getPrototypeOf(object)
   const proto = objProto ? Object.keys(objProto) : []
 
@@ -33,7 +34,5 @@ function forIn (object, func) {
     return null
   }, null)
 
-  return object
+  return Object.setPrototypeOf(object, Object.prototype)
 }
-
-export { forIn }

package/src/objects/fromEntries.d.ts

@@ -1,13 +1,11 @@
 /**
  * FromEntries takes an array of arrays with key-value pairs and returns an
  * object composed from key-value pairs.
- *
  * @param {Array} array input key-value pairs in an array of arrays
  * @returns {object} an object composed from the key-value pairs
- *
  * @example
  * const result = objects.fromEntries([['age', 12034], ['name', 'Trair'],['state', 'Floating']]);
  * console.log(result);
  * > { age: 12034, name: 'Trair', state: 'Floating' }
  */
-export function fromEntries(array: any[]): any;
+export function fromEntries(array: any[]): object;

package/src/objects/fromEntries.js

@@ -1,3 +1,5 @@
+// @ts-nocheck TODO: Fix types on this later
+
 /**
  * FromEntries takes an array of arrays with key-value pairs and returns an
  * object composed from key-value pairs.
@@ -8,11 +10,9 @@
  * console.log(result);
  * > { age: 12034, name: 'Trair', state: 'Floating' }
  */
-function fromEntries (array) {
+export function fromEntries (array) {
   return array.reduce((acc, curr) => {
     acc[curr[0]] = curr[1]
     return acc
   }, {})
 }
-
-export { fromEntries }

package/src/objects/get.d.ts

@@ -1,19 +1,16 @@
 /**
  * Get, creates an array of values corresponding to paths of the object
- *
  * @param {object} object input object
  * @param {Array|string} path string or an array of strings describing paths to be returned from an object
  * @param {*} [defaultValue] value returned when path resolves undefined
  * @returns {*} value found by object paths in object, or returns defaultValue if provided and return would otherwise be undefined
- *
  * @example
  * const result = objects.get({ front: [1, 3, 5], back: [37, 39] });
  * console.log(result, 'back[1]');
  * > 39
- *
  * @example
  * const result = objects.get({ front: [1, 3, 5], back: [37, 39] });
  * console.log(result, ['front', 5], "no value here");
  * > 'no value here'
  */
-export function get(object: any, path: string | any[], defaultValue?: any): any;
+export function get(object: object, path: any[] | string, defaultValue?: any): any;

package/src/objects/get.js

@@ -1,4 +1,5 @@
 /* eslint-disable jsdoc/reject-any-type */
+// @ts-nocheck TODO: Fix types on this later
 
 /**
  * Get, creates an array of values corresponding to paths of the object
@@ -15,7 +16,7 @@
  * console.log(result, ['front', 5], "no value here");
  * > 'no value here'
  */
-function get (object, path, defaultValue) {
+export function get (object, path, defaultValue) {
   if (typeof path === 'undefined') { return undefined }
   let pathArray
 
@@ -36,5 +37,3 @@ function get (object, path, defaultValue) {
 
   return result !== undefined ? result : defaultValue
 }
-
-export { get }

package/src/objects/has.d.ts

@@ -1,18 +1,15 @@
 /**
  * Has, creates an array of values corresponding to paths of the object
- *
  * @param {object} object input object
  * @param {Array|string} path strings describing paths to be returned from an object
  * @returns {boolean} boolean true is a direct property of the object
- *
  * @example
  * const result = objects.has({ front: [1, 3, 5], back: [37, 39] });
  * console.log(result, 'back[1]');
  * > true
- *
  * @example
  * const result = objects.has({ front: [1, 3, 5], back: [37, 39] });
  * console.log(result, ['front', 1]);
  * > true
  */
-export function has(object: any, path: string | any[]): boolean;
+export function has(object: object, path: any[] | string): boolean;

package/src/objects/has.js

@@ -1,3 +1,5 @@
+// @ts-nocheck TODO: Fix types on this later
+
 /**
  * Has, creates an array of values corresponding to paths of the object
  * @param {object} object input object
@@ -12,7 +14,7 @@
  * console.log(result, ['front', 1]);
  * > true
  */
-function has (object, path) {
+export function has (object, path) {
   if (typeof path === 'undefined') { return false }
   let pathArray
 
@@ -31,5 +33,3 @@ function has (object, path) {
     }
   }, object)
 }
-
-export { has }

package/src/objects/invert.d.ts

@@ -1,13 +1,11 @@
 /**
  * Create a new object with key-value pairs inverted, in the case of duplicate values the latter value
  * will overwrite the previous value.
- *
  * @param {object} object input string
  * @returns {object} returns an object with key-value pairs inverted
- *
  * @example
  * const result = Objects.invert({ a: 1, b: 2, c: 1 });
  * console.log(result);
  * > { '1': 'c', '2': 'b' }
  */
-export function invert(object: any): any;
+export function invert(object: object): object;

package/src/objects/invert.js

@@ -1,3 +1,5 @@
+// @ts-nocheck TODO: Fix types on this later
+
 /**
  * Create a new object with key-value pairs inverted, in the case of duplicate values the latter value
  * will overwrite the previous value.
@@ -8,11 +10,9 @@
  * console.log(result);
  * > { '1': 'c', '2': 'b' }
  */
-function invert (object) {
+export function invert (object) {
   return Object.keys(object).reduce((acc, key) => {
     acc[object[key]] = key
     return acc
   }, {})
 }
-
-export { invert }

package/src/objects/mapKeys.d.ts

@@ -1,13 +1,11 @@
 /**
  * MapKeys iterates over an object of values and applies a function to each key
- *
- * @param {Object} object input object
+ * @param {object} object input object
  * @param {Function} func map function
- * @returns {Object} object with mutated keys
- *
+ * @returns {object} object with mutated keys
  * @example
  * const result = objects.mapKeys({ a: 1, b: 2, c: 3 }, value => `neat_${value}`);
  * console.log(result);
  * > { neat_1: 1, neat_2: 2, neat_3: 3 }
  */
-export function mapKeys(object: any, func: Function): any;
+export function mapKeys(object: object, func: Function): object;

package/src/objects/mapKeys.js

@@ -1,4 +1,5 @@
 /* eslint-disable jsdoc/reject-function-type */
+// @ts-nocheck TODO: Fix types on this late
 
 /**
  * MapKeys iterates over an object of values and applies a function to each key
@@ -10,7 +11,7 @@
  * console.log(result);
  * > { neat_1: 1, neat_2: 2, neat_3: 3 }
  */
-function mapKeys (object, func) {
+export function mapKeys (object, func) {
   if (typeof func !== 'function') { return object }
   return Object.keys(object).reduce(
     (acc, key) => ({
@@ -20,5 +21,3 @@ function mapKeys (object, func) {
     {}
   )
 }
-
-export { mapKeys }

package/src/objects/mapValues.d.ts

@@ -1,13 +1,11 @@
 /**
  * MapKeys iterates over an object and applies a function to each value
- *
- * @param {Object} object input object
+ * @param {object} object input object
  * @param {Function} func map function
- * @returns {Object} object with mutated values
- *
+ * @returns {object} object with mutated values
  * @example
  * const result = objects.mapValues({ a: 1, b: 2, c: 3 }, value => `neat_${value}`);
  * console.log(result);
  * > { a: neat_1, b: neat_2, c: neat_3 }
  */
-export function mapValues(object: any, func: Function): any;
+export function mapValues(object: object, func: Function): object;

package/src/objects/mapValues.js

@@ -1,4 +1,5 @@
 /* eslint-disable jsdoc/reject-function-type */
+// @ts-nocheck TODO: Fix types on this late
 
 /**
  * MapKeys iterates over an object and applies a function to each value
@@ -10,12 +11,10 @@
  * console.log(result);
  * > { a: neat_1, b: neat_2, c: neat_3 }
  */
-function mapValues (object, func) {
+export function mapValues (object, func) {
   if (typeof func !== 'function') { return object }
   return Object.keys(object).reduce((acc, key) => ({
     ...acc,
     [key]: func(object[key], key, object)
   }), {})
 }
-
-export { mapValues }

package/src/objects/merge.d.ts

@@ -1,14 +1,12 @@
 /**
  * Merge recursively merges object properties from all supplied objects with object values
  * being merged recursively and other value types overridden when applied from left to right.
- *
  * @param {object} object input object
  * @param {...object} sources input object(s)
  * @returns {object} returns an object with all included object properties merged
- *
  * @example
  * const result = objects.merge({ hold: 25, your: 19 }, { a: 1, b: 2 });
  * console.log(result);
  * > { a: 1, b: 2, hold: 25, your: 19 }
  */
-export function merge(object: any, ...sources: any[]): any;
+export function merge(object: object, ...sources: object[]): object;

package/src/objects/merge.js

@@ -1,3 +1,5 @@
+// @ts-nocheck TODO: Fix types on this late
+
 /**
  * Merge recursively merges object properties from all supplied objects with object values
  * being merged recursively and other value types overridden when applied from left to right.
@@ -9,7 +11,7 @@
  * console.log(result);
  * > { a: 1, b: 2, hold: 25, your: 19 }
  */
-function merge (object, ...sources) {
+export function merge (object, ...sources) {
   if (arguments.length < 2) { return arguments.length === 1 ? object : {} }
   const result = [object, ...sources]
 
@@ -59,5 +61,3 @@ const objectMerge = (current, source) => {
   }, null)
   return res
 }
-
-export { merge }