es-toolkit 1.47.0-dev.1841 → 1.47.0-dev.1843

package/dist/compat/array/invokeMap.js

@@ -8,10 +8,10 @@ const require_get = require("../object/get.js");
 * Invokes the method at path of each element in collection.
 *
 * @template T, R
-* @param {ArrayLike<T> | Record<string, T> | null | undefined} collection - The collection to iterate over.
-* @param {string | ((...args: any[]) => R)} path - The path of the method to invoke or the method to invoke.
-* @param {...any[]} args - The arguments to invoke each method with.
-* @returns {Array<R | undefined>} Returns the array of results.
+* @param collection - The collection to iterate over.
+* @param path - The path of the method to invoke or the method to invoke.
+* @param args - The arguments to invoke each method with.
+* @returns Returns the array of results.
 *
 * @example
 * invokeMap([[5, 1, 7], [3, 2, 1]], 'sort');

package/dist/compat/array/invokeMap.mjs

@@ -8,10 +8,10 @@ import { get } from "../object/get.mjs";
 * Invokes the method at path of each element in collection.
 *
 * @template T, R
-* @param {ArrayLike<T> | Record<string, T> | null | undefined} collection - The collection to iterate over.
-* @param {string | ((...args: any[]) => R)} path - The path of the method to invoke or the method to invoke.
-* @param {...any[]} args - The arguments to invoke each method with.
-* @returns {Array<R | undefined>} Returns the array of results.
+* @param collection - The collection to iterate over.
+* @param path - The path of the method to invoke or the method to invoke.
+* @param args - The arguments to invoke each method with.
+* @returns Returns the array of results.
 *
 * @example
 * invokeMap([[5, 1, 7], [3, 2, 1]], 'sort');

package/dist/compat/array/join.d.mts

@@ -2,9 +2,9 @@
 /**
  * Joins elements of an array into a string.
  *
- * @param {ArrayLike<any> | null | undefined} array - The array to join.
- * @param {string} [separator=','] - The separator used to join the elements, default is common separator `,`.
- * @returns {string} - Returns a string containing all elements of the array joined by the specified separator.
+ * @param array - The array to join.
+ * @param [separator=','] - The separator used to join the elements, default is common separator `,`.
+ * @returns Returns a string containing all elements of the array joined by the specified separator.
  *
  * @example
  * const arr = ["a", "b", "c"];

package/dist/compat/array/join.d.ts

@@ -2,9 +2,9 @@
 /**
  * Joins elements of an array into a string.
  *
- * @param {ArrayLike<any> | null | undefined} array - The array to join.
- * @param {string} [separator=','] - The separator used to join the elements, default is common separator `,`.
- * @returns {string} - Returns a string containing all elements of the array joined by the specified separator.
+ * @param array - The array to join.
+ * @param [separator=','] - The separator used to join the elements, default is common separator `,`.
+ * @returns Returns a string containing all elements of the array joined by the specified separator.
  *
  * @example
  * const arr = ["a", "b", "c"];

package/dist/compat/array/join.js

@@ -3,9 +3,9 @@ const require_isArrayLike = require("../predicate/isArrayLike.js");
 /**
 * Joins elements of an array into a string.
 *
-* @param {ArrayLike<any> | null | undefined} array - The array to join.
-* @param {string} [separator=','] - The separator used to join the elements, default is common separator `,`.
-* @returns {string} - Returns a string containing all elements of the array joined by the specified separator.
+* @param array - The array to join.
+* @param [separator=','] - The separator used to join the elements, default is common separator `,`.
+* @returns Returns a string containing all elements of the array joined by the specified separator.
 *
 * @example
 * const arr = ["a", "b", "c"];

package/dist/compat/array/join.mjs

@@ -3,9 +3,9 @@ import { isArrayLike } from "../predicate/isArrayLike.mjs";
 /**
 * Joins elements of an array into a string.
 *
-* @param {ArrayLike<any> | null | undefined} array - The array to join.
-* @param {string} [separator=','] - The separator used to join the elements, default is common separator `,`.
-* @returns {string} - Returns a string containing all elements of the array joined by the specified separator.
+* @param array - The array to join.
+* @param [separator=','] - The separator used to join the elements, default is common separator `,`.
+* @returns Returns a string containing all elements of the array joined by the specified separator.
 *
 * @example
 * const arr = ["a", "b", "c"];

package/dist/compat/array/keyBy.d.mts

@@ -5,9 +5,9 @@ import { ValueIterateeCustom } from "../_internal/ValueIterateeCustom.mjs";
  * Creates an object composed of keys generated from the results of running each element of collection thru iteratee.
  *
  * @template T
- * @param {ArrayLike<T> | null | undefined} collection - The collection to iterate over.
- * @param {ValueIterateeCustom<T, PropertyKey>} [iteratee] - The iteratee to transform keys.
- * @returns {Record<string, T>} Returns the composed aggregate object.
+ * @param collection - The collection to iterate over.
+ * @param [iteratee] - The iteratee to transform keys.
+ * @returns Returns the composed aggregate object.
  *
  * @example
  * const array = [
@@ -26,9 +26,9 @@ declare function keyBy<T>(collection: ArrayLike<T> | null | undefined, iteratee?
  * Creates an object composed of keys generated from the results of running each element of collection thru iteratee.
  *
  * @template T
- * @param {T | null | undefined} collection - The object to iterate over.
- * @param {ValueIterateeCustom<T[keyof T], PropertyKey>} [iteratee] - The iteratee to transform keys.
- * @returns {Record<string, T[keyof T]>} Returns the composed aggregate object.
+ * @param collection - The object to iterate over.
+ * @param [iteratee] - The iteratee to transform keys.
+ * @returns Returns the composed aggregate object.
  *
  * @example
  * const obj = { a: { dir: 'left', code: 97 }, b: { dir: 'right', code: 100 } };

package/dist/compat/array/keyBy.d.ts

@@ -5,9 +5,9 @@ import { ValueIterateeCustom } from "../_internal/ValueIterateeCustom.js";
  * Creates an object composed of keys generated from the results of running each element of collection thru iteratee.
  *
  * @template T
- * @param {ArrayLike<T> | null | undefined} collection - The collection to iterate over.
- * @param {ValueIterateeCustom<T, PropertyKey>} [iteratee] - The iteratee to transform keys.
- * @returns {Record<string, T>} Returns the composed aggregate object.
+ * @param collection - The collection to iterate over.
+ * @param [iteratee] - The iteratee to transform keys.
+ * @returns Returns the composed aggregate object.
  *
  * @example
  * const array = [
@@ -26,9 +26,9 @@ declare function keyBy<T>(collection: ArrayLike<T> | null | undefined, iteratee?
  * Creates an object composed of keys generated from the results of running each element of collection thru iteratee.
  *
  * @template T
- * @param {T | null | undefined} collection - The object to iterate over.
- * @param {ValueIterateeCustom<T[keyof T], PropertyKey>} [iteratee] - The iteratee to transform keys.
- * @returns {Record<string, T[keyof T]>} Returns the composed aggregate object.
+ * @param collection - The object to iterate over.
+ * @param [iteratee] - The iteratee to transform keys.
+ * @returns Returns the composed aggregate object.
  *
  * @example
  * const obj = { a: { dir: 'left', code: 97 }, b: { dir: 'right', code: 100 } };

package/dist/compat/array/keyBy.js

@@ -12,14 +12,14 @@ const require_reduce = require("./reduce.js");
 * If there are multiple elements or values generating the same key, the last one among them is used
 * as the value.
 *
-* @param {ArrayLike<T> | null | undefined} collection - The collection to iterate over.
-* @param {Function | PropertyKey | Array | Object} [iteratee] - The iteratee to transform keys.
+* @param collection - The collection to iterate over.
+* @param [iteratee] - The iteratee to transform keys.
 *   - If a function is provided, it's invoked for each element in the collection.
 *   - If a property name (string) is provided, that property of each element is used as the key.
 *   - If a property-value pair (array) is provided, elements with matching property values are used.
 *   - If a partial object is provided, elements with matching properties are used.
 *   - If omitted, the identity function is used.
-* @returns {Object} Returns the composed aggregate object.
+* @returns Returns the composed aggregate object.
 *
 * @example
 * // Using an array of objects

package/dist/compat/array/keyBy.mjs

@@ -12,14 +12,14 @@ import { reduce } from "./reduce.mjs";
 * If there are multiple elements or values generating the same key, the last one among them is used
 * as the value.
 *
-* @param {ArrayLike<T> | null | undefined} collection - The collection to iterate over.
-* @param {Function | PropertyKey | Array | Object} [iteratee] - The iteratee to transform keys.
+* @param collection - The collection to iterate over.
+* @param [iteratee] - The iteratee to transform keys.
 *   - If a function is provided, it's invoked for each element in the collection.
 *   - If a property name (string) is provided, that property of each element is used as the key.
 *   - If a property-value pair (array) is provided, elements with matching property values are used.
 *   - If a partial object is provided, elements with matching properties are used.
 *   - If omitted, the identity function is used.
-* @returns {Object} Returns the composed aggregate object.
+* @returns Returns the composed aggregate object.
 *
 * @example
 * // Using an array of objects

package/dist/compat/array/last.d.mts

@@ -9,8 +9,8 @@
  * by directly accessing the last index of the array.
  *
  * @template T - The type of elements in the array.
- * @param {ArrayLike<T> | null | undefined} arr - The array from which to get the last element.
- * @returns {T | undefined} The last element of the array, or `undefined` if the array is empty.
+ * @param arr - The array from which to get the last element.
+ * @returns The last element of the array, or `undefined` if the array is empty.
  *
  * @example
  * const arr = [1, 2, 3];

package/dist/compat/array/last.d.ts

@@ -9,8 +9,8 @@
  * by directly accessing the last index of the array.
  *
  * @template T - The type of elements in the array.
- * @param {ArrayLike<T> | null | undefined} arr - The array from which to get the last element.
- * @returns {T | undefined} The last element of the array, or `undefined` if the array is empty.
+ * @param arr - The array from which to get the last element.
+ * @returns The last element of the array, or `undefined` if the array is empty.
  *
  * @example
  * const arr = [1, 2, 3];

package/dist/compat/array/last.js

@@ -12,8 +12,8 @@ const require_isArrayLike = require("../predicate/isArrayLike.js");
 * by directly accessing the last index of the array.
 *
 * @template T - The type of elements in the array.
-* @param {ArrayLike<T> | null | undefined} arr - The array from which to get the last element.
-* @returns {T | undefined} The last element of the array, or `undefined` if the array is empty.
+* @param arr - The array from which to get the last element.
+* @returns The last element of the array, or `undefined` if the array is empty.
 *
 * @example
 * const arr = [1, 2, 3];

package/dist/compat/array/last.mjs

@@ -12,8 +12,8 @@ import { isArrayLike } from "../predicate/isArrayLike.mjs";
 * by directly accessing the last index of the array.
 *
 * @template T - The type of elements in the array.
-* @param {ArrayLike<T> | null | undefined} arr - The array from which to get the last element.
-* @returns {T | undefined} The last element of the array, or `undefined` if the array is empty.
+* @param arr - The array from which to get the last element.
+* @returns The last element of the array, or `undefined` if the array is empty.
 *
 * @example
 * const arr = [1, 2, 3];

package/dist/compat/array/lastIndexOf.d.mts

@@ -3,10 +3,10 @@
  * Gets the index at which the last occurrence of value is found in array.
  *
  * @template T
- * @param {ArrayLike<T> | null | undefined} array - The array to inspect.
- * @param {T} value - The value to search for.
- * @param {true | number} [fromIndex] - The index to search from or true to search from the end.
- * @returns {number} Returns the index of the matched value, else -1.
+ * @param array - The array to inspect.
+ * @param value - The value to search for.
+ * @param [fromIndex] - The index to search from or true to search from the end.
+ * @returns Returns the index of the matched value, else -1.
  *
  * @example
  * lastIndexOf([1, 2, 1, 2], 2);

package/dist/compat/array/lastIndexOf.d.ts

@@ -3,10 +3,10 @@
  * Gets the index at which the last occurrence of value is found in array.
  *
  * @template T
- * @param {ArrayLike<T> | null | undefined} array - The array to inspect.
- * @param {T} value - The value to search for.
- * @param {true | number} [fromIndex] - The index to search from or true to search from the end.
- * @returns {number} Returns the index of the matched value, else -1.
+ * @param array - The array to inspect.
+ * @param value - The value to search for.
+ * @param [fromIndex] - The index to search from or true to search from the end.
+ * @returns Returns the index of the matched value, else -1.
  *
  * @example
  * lastIndexOf([1, 2, 1, 2], 2);

package/dist/compat/array/map.d.mts

@@ -7,9 +7,9 @@ import { TupleIterator } from "../_internal/TupleIterator.mjs";
 /**
  * Maps each element in a tuple to a new tuple of values using an iteratee.
  *
- * @param {T} collection - The tuple to iterate over
- * @param {TupleIterator<T, U>} iteratee - The function invoked per iteration
- * @returns {{ [K in keyof T]: U }} - Returns the new mapped tuple
+ * @param collection - The tuple to iterate over
+ * @param iteratee - The function invoked per iteration
+ * @returns} - Returns the new mapped tuple
  *
  * @example
  * // Using a transformation function on a tuple
@@ -20,9 +20,9 @@ declare function map<T extends readonly [unknown, ...unknown[]], U>(collection:
 /**
  * Maps each element in an array to a new array using an iteratee.
  *
- * @param {T[] | null | undefined} collection - The array to iterate over
- * @param {ArrayIterator<T, U>} iteratee - The function invoked per iteration
- * @returns {U[]} - Returns the new mapped array
+ * @param collection - The array to iterate over
+ * @param iteratee - The function invoked per iteration
+ * @returns Returns the new mapped array
  *
  * @example
  * // Using a transformation function on an array
@@ -33,9 +33,9 @@ declare function map<T, U>(collection: T[] | null | undefined, iteratee: ArrayIt
 /**
  * Maps each element in an array-like object to a new array using an iteratee.
  *
- * @param {ArrayLike<T> | null | undefined} collection - The array-like object to iterate over
- * @param {ListIterator<T, U>} iteratee - The function invoked per iteration
- * @returns {U[]} - Returns the new mapped array
+ * @param collection - The array-like object to iterate over
+ * @param iteratee - The function invoked per iteration
+ * @returns Returns the new mapped array
  *
  * @example
  * // Using a transformation function on an array-like object
@@ -46,8 +46,8 @@ declare function map<T, U>(collection: ArrayLike<T> | null | undefined, iteratee
 /**
  * Maps each value in an object to a new array.
  *
- * @param {Record<string, T> | Record<number, T> | null | undefined} collection - The object to iterate over
- * @returns {T[]} - Returns an array of the object's values
+ * @param collection - The object to iterate over
+ * @returns Returns an array of the object's values
  *
  * @example
  * // Converting an object's values to an array
@@ -58,9 +58,9 @@ declare function map<T>(collection: Record<string, T> | Record<number, T> | null
 /**
  * Maps each element in an object to a new array using an iteratee.
  *
- * @param {T | null | undefined} collection - The object to iterate over
- * @param {ObjectIterator<T, U>} iteratee - The function invoked per iteration
- * @returns {U[]} - Returns the new mapped array
+ * @param collection - The object to iterate over
+ * @param iteratee - The function invoked per iteration
+ * @returns Returns the new mapped array
  *
  * @example
  * // Using a transformation function on an object
@@ -71,9 +71,9 @@ declare function map<T extends object, U>(collection: T | null | undefined, iter
 /**
  * Maps each element in an object to a new array by plucking the specified property.
  *
- * @param {Record<string, T> | Record<number, T> | null | undefined} collection - The object to iterate over
- * @param {K} iteratee - The property to pluck from each element
- * @returns {Array<T[K]>} - Returns the new array of plucked values
+ * @param collection - The object to iterate over
+ * @param iteratee - The property to pluck from each element
+ * @returns Returns the new array of plucked values
  *
  * @example
  * // Plucking a property from each object
@@ -84,9 +84,9 @@ declare function map<T, K extends keyof T>(collection: Record<string, T> | Recor
 /**
  * Maps each element in an object to a new array by plucking the specified string property.
  *
- * @param {Record<string, T> | Record<number, T> | null | undefined} collection - The object to iterate over
- * @param {string} [iteratee] - The string property to pluck from each element
- * @returns {any[]} - Returns the new array of plucked values
+ * @param collection - The object to iterate over
+ * @param [iteratee] - The string property to pluck from each element
+ * @returns Returns the new array of plucked values
  *
  * @example
  * // Plucking a nested property
@@ -97,9 +97,9 @@ declare function map<T>(collection: Record<string, T> | Record<number, T> | null
 /**
  * Maps each element in an object to a new array by matching against a source object.
  *
- * @param {Record<string, T> | Record<number, T> | null | undefined} collection - The object to iterate over
- * @param {object} [iteratee] - The object to match against
- * @returns {boolean[]} - Returns an array of boolean values indicating matches
+ * @param collection - The object to iterate over
+ * @param [iteratee] - The object to match against
+ * @returns Returns an array of boolean values indicating matches
  *
  * @example
  * // Matching against a source object

package/dist/compat/array/map.d.ts

@@ -7,9 +7,9 @@ import { TupleIterator } from "../_internal/TupleIterator.js";
 /**
  * Maps each element in a tuple to a new tuple of values using an iteratee.
  *
- * @param {T} collection - The tuple to iterate over
- * @param {TupleIterator<T, U>} iteratee - The function invoked per iteration
- * @returns {{ [K in keyof T]: U }} - Returns the new mapped tuple
+ * @param collection - The tuple to iterate over
+ * @param iteratee - The function invoked per iteration
+ * @returns} - Returns the new mapped tuple
  *
  * @example
  * // Using a transformation function on a tuple
@@ -20,9 +20,9 @@ declare function map<T extends readonly [unknown, ...unknown[]], U>(collection:
 /**
  * Maps each element in an array to a new array using an iteratee.
  *
- * @param {T[] | null | undefined} collection - The array to iterate over
- * @param {ArrayIterator<T, U>} iteratee - The function invoked per iteration
- * @returns {U[]} - Returns the new mapped array
+ * @param collection - The array to iterate over
+ * @param iteratee - The function invoked per iteration
+ * @returns Returns the new mapped array
  *
  * @example
  * // Using a transformation function on an array
@@ -33,9 +33,9 @@ declare function map<T, U>(collection: T[] | null | undefined, iteratee: ArrayIt
 /**
  * Maps each element in an array-like object to a new array using an iteratee.
  *
- * @param {ArrayLike<T> | null | undefined} collection - The array-like object to iterate over
- * @param {ListIterator<T, U>} iteratee - The function invoked per iteration
- * @returns {U[]} - Returns the new mapped array
+ * @param collection - The array-like object to iterate over
+ * @param iteratee - The function invoked per iteration
+ * @returns Returns the new mapped array
  *
  * @example
  * // Using a transformation function on an array-like object
@@ -46,8 +46,8 @@ declare function map<T, U>(collection: ArrayLike<T> | null | undefined, iteratee
 /**
  * Maps each value in an object to a new array.
  *
- * @param {Record<string, T> | Record<number, T> | null | undefined} collection - The object to iterate over
- * @returns {T[]} - Returns an array of the object's values
+ * @param collection - The object to iterate over
+ * @returns Returns an array of the object's values
  *
  * @example
  * // Converting an object's values to an array
@@ -58,9 +58,9 @@ declare function map<T>(collection: Record<string, T> | Record<number, T> | null
 /**
  * Maps each element in an object to a new array using an iteratee.
  *
- * @param {T | null | undefined} collection - The object to iterate over
- * @param {ObjectIterator<T, U>} iteratee - The function invoked per iteration
- * @returns {U[]} - Returns the new mapped array
+ * @param collection - The object to iterate over
+ * @param iteratee - The function invoked per iteration
+ * @returns Returns the new mapped array
  *
  * @example
  * // Using a transformation function on an object
@@ -71,9 +71,9 @@ declare function map<T extends object, U>(collection: T | null | undefined, iter
 /**
  * Maps each element in an object to a new array by plucking the specified property.
  *
- * @param {Record<string, T> | Record<number, T> | null | undefined} collection - The object to iterate over
- * @param {K} iteratee - The property to pluck from each element
- * @returns {Array<T[K]>} - Returns the new array of plucked values
+ * @param collection - The object to iterate over
+ * @param iteratee - The property to pluck from each element
+ * @returns Returns the new array of plucked values
  *
  * @example
  * // Plucking a property from each object
@@ -84,9 +84,9 @@ declare function map<T, K extends keyof T>(collection: Record<string, T> | Recor
 /**
  * Maps each element in an object to a new array by plucking the specified string property.
  *
- * @param {Record<string, T> | Record<number, T> | null | undefined} collection - The object to iterate over
- * @param {string} [iteratee] - The string property to pluck from each element
- * @returns {any[]} - Returns the new array of plucked values
+ * @param collection - The object to iterate over
+ * @param [iteratee] - The string property to pluck from each element
+ * @returns Returns the new array of plucked values
  *
  * @example
  * // Plucking a nested property
@@ -97,9 +97,9 @@ declare function map<T>(collection: Record<string, T> | Record<number, T> | null
 /**
  * Maps each element in an object to a new array by matching against a source object.
  *
- * @param {Record<string, T> | Record<number, T> | null | undefined} collection - The object to iterate over
- * @param {object} [iteratee] - The object to match against
- * @returns {boolean[]} - Returns an array of boolean values indicating matches
+ * @param collection - The object to iterate over
+ * @param [iteratee] - The object to match against
+ * @returns Returns an array of boolean values indicating matches
  *
  * @example
  * // Matching against a source object

package/dist/compat/array/nth.d.mts

@@ -2,8 +2,8 @@
 /**
  * Gets the element at index `n` of `array`. If `n` is negative, the nth element from the end is returned.
  *
- * @param {ArrayLike<T> | null | undefined} array - The array to query.
- * @param {number} [n=0] - The index of the element to return.
+ * @param array - The array to query.
+ * @param [n=0] - The index of the element to return.
  * @return {T | undefined} Returns the nth element of `array`.
  *
  * @example

package/dist/compat/array/nth.d.ts

@@ -2,8 +2,8 @@
 /**
  * Gets the element at index `n` of `array`. If `n` is negative, the nth element from the end is returned.
  *
- * @param {ArrayLike<T> | null | undefined} array - The array to query.
- * @param {number} [n=0] - The index of the element to return.
+ * @param array - The array to query.
+ * @param [n=0] - The index of the element to return.
  * @return {T | undefined} Returns the nth element of `array`.
  *
  * @example

package/dist/compat/array/nth.js

@@ -4,8 +4,8 @@ const require_isArrayLikeObject = require("../predicate/isArrayLikeObject.js");
 /**
 * Gets the element at index `n` of `array`. If `n` is negative, the nth element from the end is returned.
 *
-* @param {ArrayLike<T> | null | undefined} array - The array to query.
-* @param {number} [n=0] - The index of the element to return.
+* @param array - The array to query.
+* @param [n=0] - The index of the element to return.
 * @return {T | undefined} Returns the nth element of `array`.
 *
 * @example

package/dist/compat/array/nth.mjs

@@ -4,8 +4,8 @@ import { isArrayLikeObject } from "../predicate/isArrayLikeObject.mjs";
 /**
 * Gets the element at index `n` of `array`. If `n` is negative, the nth element from the end is returned.
 *
-* @param {ArrayLike<T> | null | undefined} array - The array to query.
-* @param {number} [n=0] - The index of the element to return.
+* @param array - The array to query.
+* @param [n=0] - The index of the element to return.
 * @return {T | undefined} Returns the nth element of `array`.
 *
 * @example

package/dist/compat/array/orderBy.d.mts

@@ -10,10 +10,10 @@ type Criterion<T> = ((item: T) => unknown) | PropertyKey | PropertyKey[] | null
  * Sorts an array of elements based on multiple iteratee functions and their corresponding order directions.
  *
  * @template T The type of elements in the array
- * @param {ArrayLike<T> | null | undefined} collection The array to sort
- * @param {Many<ListIterator<T, unknown>>} iteratees The iteratee functions to sort by
- * @param {Many<boolean | 'asc' | 'desc'>} orders The sort orders
- * @returns {T[]} Returns the new sorted array
+ * @param collection The array to sort
+ * @param iteratees The iteratee functions to sort by
+ * @param orders The sort orders
+ * @returns Returns the new sorted array
  * @example
  * const users = [
  *   { name: 'fred', age: 48 },
@@ -29,10 +29,10 @@ declare function orderBy<T>(collection: ArrayLike<T> | null | undefined, iterate
  * Sorts an array of elements based on multiple property names/paths and their corresponding order directions.
  *
  * @template T The type of elements in the array
- * @param {ArrayLike<T> | null | undefined} collection The array to sort
- * @param {Many<ListIteratee<T>>} iteratees The property names/paths to sort by
- * @param {Many<boolean | 'asc' | 'desc'>} orders The sort orders
- * @returns {T[]} Returns the new sorted array
+ * @param collection The array to sort
+ * @param iteratees The property names/paths to sort by
+ * @param orders The sort orders
+ * @returns Returns the new sorted array
  * @example
  * const users = [
  *   { name: 'fred', age: 48 },
@@ -48,10 +48,10 @@ declare function orderBy<T>(collection: ArrayLike<T> | null | undefined, iterate
  * Sorts an object's values based on multiple iteratee functions and their corresponding order directions.
  *
  * @template T The object type
- * @param {T | null | undefined} collection The object to sort values from
- * @param {Many<ObjectIterator<T, unknown>>} iteratees The iteratee functions to sort by
- * @param {Many<boolean | 'asc' | 'desc'>} orders The sort orders
- * @returns {Array<T[keyof T]>} Returns the new sorted array
+ * @param collection The object to sort values from
+ * @param iteratees The iteratee functions to sort by
+ * @param orders The sort orders
+ * @returns Returns the new sorted array
  * @example
  * const obj = {
  *   a: { name: 'fred', age: 48 },
@@ -67,10 +67,10 @@ declare function orderBy<T extends object>(collection: T | null | undefined, ite
  * Sorts an object's values based on multiple property names/paths and their corresponding order directions.
  *
  * @template T The object type
- * @param {T | null | undefined} collection The object to sort values from
- * @param {Many<ObjectIteratee<T>>} iteratees The property names/paths to sort by
- * @param {Many<boolean | 'asc' | 'desc'>} orders The sort orders
- * @returns {Array<T[keyof T]>} Returns the new sorted array
+ * @param collection The object to sort values from
+ * @param iteratees The property names/paths to sort by
+ * @param orders The sort orders
+ * @returns Returns the new sorted array
  * @example
  * const obj = {
  *   a: { name: 'fred', age: 48 },

package/dist/compat/array/orderBy.d.ts

@@ -10,10 +10,10 @@ type Criterion<T> = ((item: T) => unknown) | PropertyKey | PropertyKey[] | null
  * Sorts an array of elements based on multiple iteratee functions and their corresponding order directions.
  *
  * @template T The type of elements in the array
- * @param {ArrayLike<T> | null | undefined} collection The array to sort
- * @param {Many<ListIterator<T, unknown>>} iteratees The iteratee functions to sort by
- * @param {Many<boolean | 'asc' | 'desc'>} orders The sort orders
- * @returns {T[]} Returns the new sorted array
+ * @param collection The array to sort
+ * @param iteratees The iteratee functions to sort by
+ * @param orders The sort orders
+ * @returns Returns the new sorted array
  * @example
  * const users = [
  *   { name: 'fred', age: 48 },
@@ -29,10 +29,10 @@ declare function orderBy<T>(collection: ArrayLike<T> | null | undefined, iterate
  * Sorts an array of elements based on multiple property names/paths and their corresponding order directions.
  *
  * @template T The type of elements in the array
- * @param {ArrayLike<T> | null | undefined} collection The array to sort
- * @param {Many<ListIteratee<T>>} iteratees The property names/paths to sort by
- * @param {Many<boolean | 'asc' | 'desc'>} orders The sort orders
- * @returns {T[]} Returns the new sorted array
+ * @param collection The array to sort
+ * @param iteratees The property names/paths to sort by
+ * @param orders The sort orders
+ * @returns Returns the new sorted array
  * @example
  * const users = [
  *   { name: 'fred', age: 48 },
@@ -48,10 +48,10 @@ declare function orderBy<T>(collection: ArrayLike<T> | null | undefined, iterate
  * Sorts an object's values based on multiple iteratee functions and their corresponding order directions.
  *
  * @template T The object type
- * @param {T | null | undefined} collection The object to sort values from
- * @param {Many<ObjectIterator<T, unknown>>} iteratees The iteratee functions to sort by
- * @param {Many<boolean | 'asc' | 'desc'>} orders The sort orders
- * @returns {Array<T[keyof T]>} Returns the new sorted array
+ * @param collection The object to sort values from
+ * @param iteratees The iteratee functions to sort by
+ * @param orders The sort orders
+ * @returns Returns the new sorted array
  * @example
  * const obj = {
  *   a: { name: 'fred', age: 48 },
@@ -67,10 +67,10 @@ declare function orderBy<T extends object>(collection: T | null | undefined, ite
  * Sorts an object's values based on multiple property names/paths and their corresponding order directions.
  *
  * @template T The object type
- * @param {T | null | undefined} collection The object to sort values from
- * @param {Many<ObjectIteratee<T>>} iteratees The property names/paths to sort by
- * @param {Many<boolean | 'asc' | 'desc'>} orders The sort orders
- * @returns {Array<T[keyof T]>} Returns the new sorted array
+ * @param collection The object to sort values from
+ * @param iteratees The property names/paths to sort by
+ * @param orders The sort orders
+ * @returns Returns the new sorted array
  * @example
  * const obj = {
  *   a: { name: 'fred', age: 48 },