absurdum - npm Package Compare versions

Comparing version 0.56.1 to 0.56.2

dist/absurdum.esm.js

@@ -311,3 +311,3 @@ /**
  * @param {Array} array input array
- * @param {Array} [depth=1] optional depth of array elements to flat
+ * @param {number} [depth=1] optional depth of array elements to flat
  * @returns {Array} the flattened array
@@ -1394,3 +1394,3 @@ *
  * @param {object} object input object
- * @param {...object} [sources] input object/s
+ * @param {...object} sources input object/s
  * @returns {object} returns an object with all included object properties merged
@@ -1397,0 +1397,0 @@ *

docs/arrays/flat.md

@@ -16,3 +16,3 @@ # arrays.flat
 1. `array` *(Array)*: input array
-2. `[depth=1]` *(Array)*: optional depth of array elements to flat
+2. `[depth=1]` *(number)*: optional depth of array elements to flat
 
@@ -19,0 +19,0 @@ #### Returns

docs/objects/merge.md

@@ -10,3 +10,3 @@ # objects.merge
 
-<h3 id="mergeobject-sources"><code>merge(object, [sources])</code></h3>
+<h3 id="mergeobject-sources"><code>merge(object, sources)</code></h3>
 
@@ -18,3 +18,3 @@ Merge recursively merges object properties from all supplied objects with object values
 1. `object` *(object)*: input object
-2. `[sources]` *(...object)*: input object/s
+2. `sources` *(...object)*: input object/s
 
@@ -21,0 +21,0 @@ #### Returns

package.json

 {
   "name": "absurdum",
-  "version": "0.56.1",
+  "version": "0.56.2",
   "description": "Reductio Ad Absurdum - The Ridiculous Application of Reduce",
@@ -43,3 +43,3 @@ "keywords": [
     "clean:bundles": "npx rimraf dist/*",
-    "clean:typings": "npx rimraf src/*.d.ts",
+    "clean:typings": "npx rimraf src/**/*.d.ts",
     "package": "npx rimraf package && npm pack | tail -n 1 | xargs tar -xf",
@@ -46,0 +46,0 @@ "preversion": "npm test && npm run lint && npm run types",

src/arrays/concat.d.ts

@@ -10,4 +10,4 @@ /**
  * console.log(result);
- * > [1, 2, 3, 4]
+ * > [1, 2, 3, [4]]
  */
 export function concat(...arrays: any[]): any[];

src/arrays/find.d.ts

@@ -7,3 +7,3 @@ /**
  * @param {Function} predicate to be run against each element of the array
- * @param {*} thisArg of this
+ * @param {*} [thisArg=undefined] of this
  * @returns {*} value of element that satisfied function.
@@ -10,0 +10,0 @@ * @example

src/arrays/flat.d.ts

 /**
- * Flattens an array of nested arrays
+ * Flat flattens an array of nested arrays
  *
  * @param {Array} array input array
- * @param {Array} initial reducer initial state
+ * @param {number} [depth=1] optional depth of array elements to flat
  * @returns {Array} the flattened array
@@ -11,4 +11,4 @@ *
  * console.log(result);
- * > [1, 2, 3, 4]
+ * > [1, 2, [3, [4]]]
  */
-export function flat(array: any[], initial?: any[]): any[];
+export function flat(array: any[], depth?: number): any[];

src/arrays/flat.js

@@ -5,3 +5,3 @@ /**
  * @param {Array} array input array
- * @param {Array} [depth=1] optional depth of array elements to flat
+ * @param {number} [depth=1] optional depth of array elements to flat
  * @returns {Array} the flattened array
@@ -8,0 +8,0 @@ *

src/arrays/index.d.ts

@@ -30,5 +30,5 @@ export { chunk } from "./chunk.js";
 export { tap } from "./tap.js";
+export { union } from "./union.js";
 export { unique } from "./unique.js";
-export { union } from "./union.js";
 export { unzip } from "./unzip.js";
 export { zip } from "./zip.js";

src/arrays/indexOf.d.ts

@@ -7,3 +7,3 @@ /**
  * @param {number} searchElement to be looked for in the array
- * @param {number} start index in array to begin searching for search Element
+ * @param {number} [start=0] index in array to begin searching for search Element
  * @returns {number} a integer representing the first index in the array that contains the element
@@ -10,0 +10,0 @@ * @example

src/arrays/zip.d.ts

@@ -7,3 +7,3 @@ /**
  * @param {Array} array2 input array
- * @param {Function} predicate optional to be applied to corresponding values
+ * @param {Function} [predicate=(a, b)=>[a, b]] to be applied to corresponding values
  * @returns {Array} input array filled value pairs after the function has been applied
@@ -10,0 +10,0 @@ *

src/objects/include.d.ts

 /**
- * Include determines whether one string can be found in another string
+ * Include filters elements in a new object based on an array of keys to include
  *
@@ -4,0 +4,0 @@ * @param {object} object input string

src/objects/merge.d.ts

@@ -6,4 +6,4 @@ /**
  * @param {object} object input object
- * @param {...object} [sources] input object
- * @returns {array} returns an array of all values in an object
+ * @param {...object} sources input object/s
+ * @returns {object} returns an object with all included object properties merged
  *
@@ -15,2 +15,2 @@ * @example
  */
-export function merge(object: any, ...sources?: any[]): any[];
+export function merge(object: any, ...sources: any[]): any;

src/objects/merge.js

@@ -6,3 +6,3 @@ /**
  * @param {object} object input object
- * @param {...object} [sources] input object/s
+ * @param {...object} sources input object/s
  * @returns {object} returns an object with all included object properties merged
@@ -9,0 +9,0 @@ *

src/strings/startsWith.d.ts

@@ -6,3 +6,3 @@ /**
  * @param {string} substr substring to test
- * @returns {string} does the input start with the substring?
+ * @returns {boolean} does the input start with the substring?
  *
@@ -19,2 +19,2 @@ * @example
  */
-export function startsWith(string: string, substr: string): string;
+export function startsWith(string: string, substr: string): boolean;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

202621

increased by0.04%

No dependency changes