atomic-fns 1.1.7 → 1.2.0

package/dist/collections/index.d.ts

@@ -4,7 +4,7 @@
  * @module collections
  */
 import { compare } from '../operators/index.js';
-import { Iteratee } from '../types';
+import type { Iteratee } from '../types.js';
 export * from './abc.js';
 export * from './BTree.js';
 export * from './deque.js';
@@ -38,7 +38,6 @@ export declare function compact<T>(arr: T): Partial<T>;
 count([6.1, 4.2, 6.3], Math.floor);
 // { '4': 1, '6': 2 }
 
-// property iteratee shorthand.
 count(['one', 'two', 'three'], x => x.length);
 // { '3': 2, '5': 1 }
 ```
@@ -153,7 +152,7 @@ forEach({ 'a': 1, 'b': 2 }, (value, key) => {
 ```
  * @param {Array|Object} collection The collection to iterate over.
  * @param {Iteratee} fn The function invoked per iteration.
- * @returns {*} Returns `collection`.
+ * @returns {void}
  * @see {@link forEachRight}
  * @see {@link filter}
  * @see {@link map}
@@ -187,7 +186,7 @@ forEachRight([1, 2], console.log)
 ```
  * @param {Array|Object} collection The collection to iterate over.
  * @param {Iteratee} fn The function invoked per iteration.
- * @returns {*} Returns `collection`.
+ * @returns {void}
  * @see {@link forEach}
  * @see {@link filter}
  * @see {@link map}
@@ -286,7 +285,7 @@ pick(object, x => isNumber(x))
 export declare function pick<T>(obj: T, paths: Iteratee): Partial<T>;
 export declare function pick<T>(obj: T, paths: PropertyKey[]): Partial<T>;
 /**
- * The opposite of {@link pick} - this method creates an object composed of the own and inherited enumerable property paths of `object` that are not omitted.
+ * The opposite of {@link pick} - this method creates an object composed of the own enumerable properties of `object` that are not omitted.
  * @example
 ```js
 let object = { 'a': 1, 'b': '2', 'c': 3 }
@@ -410,27 +409,9 @@ export declare function lastIndexOf<T>(obj: T[], value: T, start?: number): numb
  * @param {*} value
  * @param {boolean} [deep=false]
  * @return The clone value
- * @see {@link cloneArray}
- * @see {@link cloneTypedArray}
  */
 export declare function clone<T>(value: T, deep?: boolean): T;
 export declare function clone<T>(value: T[], deep?: boolean): T[];
-/**
- * Clones an array. If `deep` is `false` (default) the clone will be shallow. Otherwise {@link https://developer.mozilla.org/en-US/docs/Web/API/structuredClone structuredClone} is used.
- * @param arr The array to clone
- * @param [deep=false] Creates a deep clone using `structuredClone` if true.
- * @returns The new array
- * @see {@link clone}
- */
-export declare function cloneArray<T>(arr: T[], deep?: boolean): T[];
-/**
- * Clones a typed array. If `deep` is `false` (default) the clone will be shallow. Otherwise {@link https://developer.mozilla.org/en-US/docs/Web/API/structuredClone structuredClone} is used.
- * @param arr The array to clone
- * @param [deep=false] Creates a deep clone using `structuredClone` if true.
- * @returns The new array
- * @see {@link clone}
- */
-export declare function cloneTypedArray(typedArray: any, isDeep?: boolean): any;
 /**
  * Creates a duplicate-free version of an array, using a `Set` for equality comparisons, in which only the first occurrence of each element is kept. The order of result values is not guaranteed.
  * @param arr The array containing duplicated elements
@@ -456,7 +437,7 @@ export declare function uniq<T>(arr: Iterable<T>, fn?: PropertyKey): T[];
  * @returns Returns the new duplicate free array
  * @example
 ```js
-uniq([2, 1, 2])
+sortedUniq([2, 1, 2])
 // [1, 2]
 ```
  * @see {@link uniq}
@@ -464,7 +445,7 @@ uniq([2, 1, 2])
 export declare function sortedUniq<T>(arr: Iterable<T>, fn?: Iteratee<T>): T[];
 export declare function sortedUniq<T>(arr: Iterable<T>, fn?: PropertyKey): T[];
 /**
- * Recursively merges own and inherited enumerable string keyed properties of source objects into the destination object. Source properties that resolve to `undefined` are skipped if a destination value exists. Array and plain object properties are merged recursively. Other objects and value types are overridden by assignment. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources.
+ * Recursively merges own enumerable string keyed properties of source objects into the destination object. Source properties that resolve to `undefined` are skipped if a destination value exists. Array and plain object properties are merged recursively. Other objects and value types are overridden by assignment. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources.
  *
  * Note: this method mutates `object`
  *
@@ -542,7 +523,7 @@ export declare function union<T>(...args: Array<Iterable<T>>): Generator<T>;
  * Creates an object composed of keys generated from the results of running each element of `arr` thru `func`. The order of grouped values is determined by the order they occur in `arr`. The corresponding value of each key is an array of elements responsible for generating the key.
  *
  * @param arr The collection to iterate over.
- * @param [func=id] The iteratee to transform keys.
+ * @param [func=identity] The iteratee to transform keys.
  * @returns Returns the aggregated object.
  *
  * @example
@@ -563,14 +544,14 @@ export declare function groupBy<T>(arr: Object, fn: PropertyKey): Record<Propert
  * Similar to {@link groupBy} but it returns a {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map Map} object with the results.
  *
  * @param arr The collection to iterate over.
- * @param {Function | PropertyKey} [func=id] The iteratee to transform keys.
+ * @param {Function | PropertyKey} [func=identity] The iteratee to transform keys.
  * @returns {Map} Returns the aggregated map object.
  * @template K, V
  *
  * @example
 ```js
 groupByMap([6.1, 4.2, 6.3], Math.floor)
-// Map { 4: [4.2], 6: [6.1, 6.3] }
+// Map { 6: [6.1, 6.3], 4: [4.2] }
 
 // The `property` iteratee shorthand.
 groupByMap(['one', 'two', 'three'], 'length')
@@ -592,8 +573,8 @@ export declare function remove<T>(arr: T[], func: T[]): T[];
 export declare function remove<T>(arr: T[], func: Iteratee<T>): T[];
 /**
  * Returns the index of `x` in a **sorted** array if found, in `O(log n)` using binary search.
- * If the element is not found, returns a negative integer.
- * @param arr The array to sort
+ * If the element is not found, returns `-n - 1`, where `n` is the index to insert `x` at.
+ * @param arr The sorted array
  * @param x The element to find
  * @param lo The starting index
  * @param hi The end index to search within
@@ -603,7 +584,7 @@ export declare function remove<T>(arr: T[], func: Iteratee<T>): T[];
 export declare function binarySearch(arr: any[], x: any, lo?: number, hi?: any, comp?: typeof compare): number;
 /**
  * Returns an insertion index which comes after any existing entries of `x` in a **sorted** array, using binary search.
- * @param arr The array to sort
+ * @param arr The sorted array
  * @param x The element to find
  * @param lo The starting index
  * @param hi The end index to search within
@@ -613,7 +594,7 @@ export declare function binarySearch(arr: any[], x: any, lo?: number, hi?: any,
 export declare function bisect(arr: any[], x: any, lo?: number, hi?: any, comp?: typeof compare): number;
 /**
  * Returns an insertion index which comes before any existing entries of `x` in a **sorted** array, using binary search.
- * @param arr The array to sort
+ * @param arr The sorted array
  * @param x The element to find
  * @param lo The starting index
  * @param hi The end index to search within