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

package/dist/array/intersectionWith.d.ts

@@ -9,11 +9,11 @@
  *
  * @template T - The type of elements in the first array.
  * @template U - The type of elements in the second array.
- * @param {T[]} firstArr - The first array to compare.
- * @param {U[]} secondArr - The second array to compare.
- * @param {(x: T, y: U) => boolean} areItemsEqual - A custom function to determine if two elements are equal.
+ * @param firstArr - The first array to compare.
+ * @param secondArr - The second array to compare.
+ * @param areItemsEqual - A custom function to determine if two elements are equal.
  * This function takes two arguments, one from each array, and returns `true` if the elements are considered equal, and `false` otherwise.
- * @returns {T[]} A new array containing the elements from the first array that have corresponding matches in the second array according to the custom equality function.
+ * @returns A new array containing the elements from the first array that have corresponding matches in the second array according to the custom equality function.
  *
  * @example
  * const array1 = [{ id: 1 }, { id: 2 }, { id: 3 }];

package/dist/array/intersectionWith.js

@@ -9,11 +9,11 @@
 *
 * @template T - The type of elements in the first array.
 * @template U - The type of elements in the second array.
-* @param {T[]} firstArr - The first array to compare.
-* @param {U[]} secondArr - The second array to compare.
-* @param {(x: T, y: U) => boolean} areItemsEqual - A custom function to determine if two elements are equal.
+* @param firstArr - The first array to compare.
+* @param secondArr - The second array to compare.
+* @param areItemsEqual - A custom function to determine if two elements are equal.
 * This function takes two arguments, one from each array, and returns `true` if the elements are considered equal, and `false` otherwise.
-* @returns {T[]} A new array containing the elements from the first array that have corresponding matches in the second array according to the custom equality function.
+* @returns A new array containing the elements from the first array that have corresponding matches in the second array according to the custom equality function.
 *
 * @example
 * const array1 = [{ id: 1 }, { id: 2 }, { id: 3 }];

package/dist/array/intersectionWith.mjs

@@ -9,11 +9,11 @@
 *
 * @template T - The type of elements in the first array.
 * @template U - The type of elements in the second array.
-* @param {T[]} firstArr - The first array to compare.
-* @param {U[]} secondArr - The second array to compare.
-* @param {(x: T, y: U) => boolean} areItemsEqual - A custom function to determine if two elements are equal.
+* @param firstArr - The first array to compare.
+* @param secondArr - The second array to compare.
+* @param areItemsEqual - A custom function to determine if two elements are equal.
 * This function takes two arguments, one from each array, and returns `true` if the elements are considered equal, and `false` otherwise.
-* @returns {T[]} A new array containing the elements from the first array that have corresponding matches in the second array according to the custom equality function.
+* @returns A new array containing the elements from the first array that have corresponding matches in the second array according to the custom equality function.
 *
 * @example
 * const array1 = [{ id: 1 }, { id: 2 }, { id: 3 }];

package/dist/array/isSubset.d.mts

@@ -4,9 +4,9 @@
  *
  *
  * @template T - The type of elements contained in the arrays.
- * @param {T[]} superset - The array that may contain all elements of the subset.
- * @param {T[]} subset - The array to check against the superset.
- * @returns {boolean} - Returns `true` if all elements of the `subset` are present in the `superset`, otherwise returns `false`.
+ * @param superset - The array that may contain all elements of the subset.
+ * @param subset - The array to check against the superset.
+ * @returns Returns `true` if all elements of the `subset` are present in the `superset`, otherwise returns `false`.
  *
  * @example
  * ```typescript

package/dist/array/isSubset.d.ts

@@ -4,9 +4,9 @@
  *
  *
  * @template T - The type of elements contained in the arrays.
- * @param {T[]} superset - The array that may contain all elements of the subset.
- * @param {T[]} subset - The array to check against the superset.
- * @returns {boolean} - Returns `true` if all elements of the `subset` are present in the `superset`, otherwise returns `false`.
+ * @param superset - The array that may contain all elements of the subset.
+ * @param subset - The array to check against the superset.
+ * @returns Returns `true` if all elements of the `subset` are present in the `superset`, otherwise returns `false`.
  *
  * @example
  * ```typescript

package/dist/array/isSubset.js

@@ -5,9 +5,9 @@ const require_difference = require("./difference.js");
 *
 *
 * @template T - The type of elements contained in the arrays.
-* @param {T[]} superset - The array that may contain all elements of the subset.
-* @param {T[]} subset - The array to check against the superset.
-* @returns {boolean} - Returns `true` if all elements of the `subset` are present in the `superset`, otherwise returns `false`.
+* @param superset - The array that may contain all elements of the subset.
+* @param subset - The array to check against the superset.
+* @returns Returns `true` if all elements of the `subset` are present in the `superset`, otherwise returns `false`.
 *
 * @example
 * ```typescript

package/dist/array/isSubset.mjs

@@ -5,9 +5,9 @@ import { difference } from "./difference.mjs";
 *
 *
 * @template T - The type of elements contained in the arrays.
-* @param {T[]} superset - The array that may contain all elements of the subset.
-* @param {T[]} subset - The array to check against the superset.
-* @returns {boolean} - Returns `true` if all elements of the `subset` are present in the `superset`, otherwise returns `false`.
+* @param superset - The array that may contain all elements of the subset.
+* @param subset - The array to check against the superset.
+* @returns Returns `true` if all elements of the `subset` are present in the `superset`, otherwise returns `false`.
 *
 * @example
 * ```typescript

package/dist/array/isSubsetWith.d.mts

@@ -7,10 +7,10 @@
  * custom equality function.
  *
  * @template T - The type of elements contained in the arrays.
- * @param {T[]} superset - The array that may contain all elements of the subset.
- * @param {T[]} subset - The array to check against the superset.
- * @param {(x: T, y: T) => boolean} areItemsEqual - A function to determine if two items are equal.
- * @returns {boolean} - Returns `true` if all elements of the subset are present in the superset
+ * @param superset - The array that may contain all elements of the subset.
+ * @param subset - The array to check against the superset.
+ * @param areItemsEqual - A function to determine if two items are equal.
+ * @returns Returns `true` if all elements of the subset are present in the superset
  * according to the custom equality function, otherwise returns `false`.
  *
  * @example

package/dist/array/isSubsetWith.d.ts

@@ -7,10 +7,10 @@
  * custom equality function.
  *
  * @template T - The type of elements contained in the arrays.
- * @param {T[]} superset - The array that may contain all elements of the subset.
- * @param {T[]} subset - The array to check against the superset.
- * @param {(x: T, y: T) => boolean} areItemsEqual - A function to determine if two items are equal.
- * @returns {boolean} - Returns `true` if all elements of the subset are present in the superset
+ * @param superset - The array that may contain all elements of the subset.
+ * @param subset - The array to check against the superset.
+ * @param areItemsEqual - A function to determine if two items are equal.
+ * @returns Returns `true` if all elements of the subset are present in the superset
  * according to the custom equality function, otherwise returns `false`.
  *
  * @example

package/dist/array/isSubsetWith.js

@@ -8,10 +8,10 @@ const require_differenceWith = require("./differenceWith.js");
 * custom equality function.
 *
 * @template T - The type of elements contained in the arrays.
-* @param {T[]} superset - The array that may contain all elements of the subset.
-* @param {T[]} subset - The array to check against the superset.
-* @param {(x: T, y: T) => boolean} areItemsEqual - A function to determine if two items are equal.
-* @returns {boolean} - Returns `true` if all elements of the subset are present in the superset
+* @param superset - The array that may contain all elements of the subset.
+* @param subset - The array to check against the superset.
+* @param areItemsEqual - A function to determine if two items are equal.
+* @returns Returns `true` if all elements of the subset are present in the superset
 * according to the custom equality function, otherwise returns `false`.
 *
 * @example

package/dist/array/isSubsetWith.mjs

@@ -8,10 +8,10 @@ import { differenceWith } from "./differenceWith.mjs";
 * custom equality function.
 *
 * @template T - The type of elements contained in the arrays.
-* @param {T[]} superset - The array that may contain all elements of the subset.
-* @param {T[]} subset - The array to check against the superset.
-* @param {(x: T, y: T) => boolean} areItemsEqual - A function to determine if two items are equal.
-* @returns {boolean} - Returns `true` if all elements of the subset are present in the superset
+* @param superset - The array that may contain all elements of the subset.
+* @param subset - The array to check against the superset.
+* @param areItemsEqual - A function to determine if two items are equal.
+* @returns Returns `true` if all elements of the subset are present in the superset
 * according to the custom equality function, otherwise returns `false`.
 *
 * @example

package/dist/array/keyBy.d.mts

@@ -9,9 +9,9 @@
  *
  * @template T - The type of elements in the array.
  * @template K - The type of keys.
- * @param {T[]} arr - The array of elements to be mapped.
- * @param {(item: T, index: number, array: readonly T[]) => K} getKeyFromItem - A function that generates a key from an element, its index, and the array.
- * @returns {Record<K, T>} An object where keys are mapped to each element of an array.
+ * @param arr - The array of elements to be mapped.
+ * @param getKeyFromItem - A function that generates a key from an element, its index, and the array.
+ * @returns An object where keys are mapped to each element of an array.
  *
  * @example
  * const array = [

package/dist/array/keyBy.d.ts

@@ -9,9 +9,9 @@
  *
  * @template T - The type of elements in the array.
  * @template K - The type of keys.
- * @param {T[]} arr - The array of elements to be mapped.
- * @param {(item: T, index: number, array: readonly T[]) => K} getKeyFromItem - A function that generates a key from an element, its index, and the array.
- * @returns {Record<K, T>} An object where keys are mapped to each element of an array.
+ * @param arr - The array of elements to be mapped.
+ * @param getKeyFromItem - A function that generates a key from an element, its index, and the array.
+ * @returns An object where keys are mapped to each element of an array.
  *
  * @example
  * const array = [

package/dist/array/keyBy.js

@@ -9,9 +9,9 @@
 *
 * @template T - The type of elements in the array.
 * @template K - The type of keys.
-* @param {T[]} arr - The array of elements to be mapped.
-* @param {(item: T, index: number, array: readonly T[]) => K} getKeyFromItem - A function that generates a key from an element, its index, and the array.
-* @returns {Record<K, T>} An object where keys are mapped to each element of an array.
+* @param arr - The array of elements to be mapped.
+* @param getKeyFromItem - A function that generates a key from an element, its index, and the array.
+* @returns An object where keys are mapped to each element of an array.
 *
 * @example
 * const array = [

package/dist/array/keyBy.mjs

@@ -9,9 +9,9 @@
 *
 * @template T - The type of elements in the array.
 * @template K - The type of keys.
-* @param {T[]} arr - The array of elements to be mapped.
-* @param {(item: T, index: number, array: readonly T[]) => K} getKeyFromItem - A function that generates a key from an element, its index, and the array.
-* @returns {Record<K, T>} An object where keys are mapped to each element of an array.
+* @param arr - The array of elements to be mapped.
+* @param getKeyFromItem - A function that generates a key from an element, its index, and the array.
+* @returns An object where keys are mapped to each element of an array.
 *
 * @example
 * const array = [

package/dist/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 {[...T[], T]} arr - The array from which to get the last element.
- * @returns {T} 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];
@@ -32,8 +32,8 @@ declare function last<T>(arr: readonly [...T[], T]): T;
  * by directly accessing the last index of the array.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} 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/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 {[...T[], T]} arr - The array from which to get the last element.
- * @returns {T} 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];
@@ -32,8 +32,8 @@ declare function last<T>(arr: readonly [...T[], T]): T;
  * by directly accessing the last index of the array.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} 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/array/last.js

@@ -9,8 +9,8 @@
 * by directly accessing the last index of the array.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} 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/array/last.mjs

@@ -9,8 +9,8 @@
 * by directly accessing the last index of the array.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} 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/array/limitAsync.d.mts

@@ -7,9 +7,9 @@
  * wait until a slot becomes available.
  *
  * @template F - The type of the async function to wrap.
- * @param {F} callback The async function to wrap with concurrency control.
- * @param {number} concurrency Maximum number of concurrent executions allowed.
- * @returns {F} A wrapped version of the callback with concurrency limiting.
+ * @param callback The async function to wrap with concurrency control.
+ * @param concurrency Maximum number of concurrent executions allowed.
+ * @returns A wrapped version of the callback with concurrency limiting.
  * @example
  * const limitedFetch = limitAsync(async (url) => {
  *   return await fetch(url);

package/dist/array/limitAsync.d.ts

@@ -7,9 +7,9 @@
  * wait until a slot becomes available.
  *
  * @template F - The type of the async function to wrap.
- * @param {F} callback The async function to wrap with concurrency control.
- * @param {number} concurrency Maximum number of concurrent executions allowed.
- * @returns {F} A wrapped version of the callback with concurrency limiting.
+ * @param callback The async function to wrap with concurrency control.
+ * @param concurrency Maximum number of concurrent executions allowed.
+ * @returns A wrapped version of the callback with concurrency limiting.
  * @example
  * const limitedFetch = limitAsync(async (url) => {
  *   return await fetch(url);

package/dist/array/limitAsync.js

@@ -8,9 +8,9 @@ const require_semaphore = require("../promise/semaphore.js");
 * wait until a slot becomes available.
 *
 * @template F - The type of the async function to wrap.
-* @param {F} callback The async function to wrap with concurrency control.
-* @param {number} concurrency Maximum number of concurrent executions allowed.
-* @returns {F} A wrapped version of the callback with concurrency limiting.
+* @param callback The async function to wrap with concurrency control.
+* @param concurrency Maximum number of concurrent executions allowed.
+* @returns A wrapped version of the callback with concurrency limiting.
 * @example
 * const limitedFetch = limitAsync(async (url) => {
 *   return await fetch(url);

package/dist/array/limitAsync.mjs

@@ -8,9 +8,9 @@ import { Semaphore } from "../promise/semaphore.mjs";
 * wait until a slot becomes available.
 *
 * @template F - The type of the async function to wrap.
-* @param {F} callback The async function to wrap with concurrency control.
-* @param {number} concurrency Maximum number of concurrent executions allowed.
-* @returns {F} A wrapped version of the callback with concurrency limiting.
+* @param callback The async function to wrap with concurrency control.
+* @param concurrency Maximum number of concurrent executions allowed.
+* @returns A wrapped version of the callback with concurrency limiting.
 * @example
 * const limitedFetch = limitAsync(async (url) => {
 *   return await fetch(url);

package/dist/array/mapAsync.d.mts

@@ -8,11 +8,11 @@ interface MapAsyncOptions {
  *
  * @template T - The type of elements in the input array.
  * @template R - The type of elements in the output array.
- * @param {readonly T[]} array The array to transform.
- * @param {(item: T, index: number, array: readonly T[]) => Promise<R>} callback An async function that transforms each element.
- * @param {MapAsyncOptions} [options] Optional configuration object.
- * @param {number} [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
- * @returns {Promise<R[]>} A promise that resolves to an array of transformed values.
+ * @param array The array to transform.
+ * @param callback An async function that transforms each element.
+ * @param [options] Optional configuration object.
+ * @param [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
+ * @returns A promise that resolves to an array of transformed values.
  * @example
  * const users = [{ id: 1 }, { id: 2 }, { id: 3 }];
  * const userDetails = await mapAsync(users, async (user) => {

package/dist/array/mapAsync.d.ts

@@ -8,11 +8,11 @@ interface MapAsyncOptions {
  *
  * @template T - The type of elements in the input array.
  * @template R - The type of elements in the output array.
- * @param {readonly T[]} array The array to transform.
- * @param {(item: T, index: number, array: readonly T[]) => Promise<R>} callback An async function that transforms each element.
- * @param {MapAsyncOptions} [options] Optional configuration object.
- * @param {number} [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
- * @returns {Promise<R[]>} A promise that resolves to an array of transformed values.
+ * @param array The array to transform.
+ * @param callback An async function that transforms each element.
+ * @param [options] Optional configuration object.
+ * @param [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
+ * @returns A promise that resolves to an array of transformed values.
  * @example
  * const users = [{ id: 1 }, { id: 2 }, { id: 3 }];
  * const userDetails = await mapAsync(users, async (user) => {

package/dist/array/mapAsync.js

@@ -6,11 +6,11 @@ const require_limitAsync = require("./limitAsync.js");
 *
 * @template T - The type of elements in the input array.
 * @template R - The type of elements in the output array.
-* @param {readonly T[]} array The array to transform.
-* @param {(item: T, index: number, array: readonly T[]) => Promise<R>} callback An async function that transforms each element.
-* @param {MapAsyncOptions} [options] Optional configuration object.
-* @param {number} [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
-* @returns {Promise<R[]>} A promise that resolves to an array of transformed values.
+* @param array The array to transform.
+* @param callback An async function that transforms each element.
+* @param [options] Optional configuration object.
+* @param [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
+* @returns A promise that resolves to an array of transformed values.
 * @example
 * const users = [{ id: 1 }, { id: 2 }, { id: 3 }];
 * const userDetails = await mapAsync(users, async (user) => {

package/dist/array/mapAsync.mjs

@@ -6,11 +6,11 @@ import { limitAsync } from "./limitAsync.mjs";
 *
 * @template T - The type of elements in the input array.
 * @template R - The type of elements in the output array.
-* @param {readonly T[]} array The array to transform.
-* @param {(item: T, index: number, array: readonly T[]) => Promise<R>} callback An async function that transforms each element.
-* @param {MapAsyncOptions} [options] Optional configuration object.
-* @param {number} [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
-* @returns {Promise<R[]>} A promise that resolves to an array of transformed values.
+* @param array The array to transform.
+* @param callback An async function that transforms each element.
+* @param [options] Optional configuration object.
+* @param [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
+* @returns A promise that resolves to an array of transformed values.
 * @example
 * const users = [{ id: 1 }, { id: 2 }, { id: 3 }];
 * const userDetails = await mapAsync(users, async (user) => {

package/dist/array/maxBy.d.mts

@@ -4,9 +4,9 @@
  * the `getValue` function to each element.
  *
  * @template T - The type of elements in the array.
- * @param {[T, ...T[]]} items The nonempty array of elements to search.
- * @param {(element: T) => number} getValue A function that selects a numeric value from each element.
- * @returns {T} The element with the maximum value as determined by the `getValue` function.
+ * @param items The nonempty array of elements to search.
+ * @param getValue A function that selects a numeric value from each element.
+ * @returns The element with the maximum value as determined by the `getValue` function.
  * @example
  * maxBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 3 }
  * maxBy([], x => x.a); // Returns: undefined
@@ -25,9 +25,9 @@ declare function maxBy<T>(items: readonly [T, ...T[]], getValue: (element: T, in
  * the `getValue` function to each element.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} items The array of elements to search.
- * @param {(element: T, index: number, array: readonly T[]) => number} getValue A function that selects a numeric value from each element.
- * @returns {T | undefined} The element with the maximum value as determined by the `getValue` function,
+ * @param items The array of elements to search.
+ * @param getValue A function that selects a numeric value from each element.
+ * @returns The element with the maximum value as determined by the `getValue` function,
  * or `undefined` if the array is empty.
  * @example
  * maxBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 3 }

package/dist/array/maxBy.d.ts

@@ -4,9 +4,9 @@
  * the `getValue` function to each element.
  *
  * @template T - The type of elements in the array.
- * @param {[T, ...T[]]} items The nonempty array of elements to search.
- * @param {(element: T) => number} getValue A function that selects a numeric value from each element.
- * @returns {T} The element with the maximum value as determined by the `getValue` function.
+ * @param items The nonempty array of elements to search.
+ * @param getValue A function that selects a numeric value from each element.
+ * @returns The element with the maximum value as determined by the `getValue` function.
  * @example
  * maxBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 3 }
  * maxBy([], x => x.a); // Returns: undefined
@@ -25,9 +25,9 @@ declare function maxBy<T>(items: readonly [T, ...T[]], getValue: (element: T, in
  * the `getValue` function to each element.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} items The array of elements to search.
- * @param {(element: T, index: number, array: readonly T[]) => number} getValue A function that selects a numeric value from each element.
- * @returns {T | undefined} The element with the maximum value as determined by the `getValue` function,
+ * @param items The array of elements to search.
+ * @param getValue A function that selects a numeric value from each element.
+ * @returns The element with the maximum value as determined by the `getValue` function,
  * or `undefined` if the array is empty.
  * @example
  * maxBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 3 }

package/dist/array/maxBy.js

@@ -4,9 +4,9 @@
 * the `getValue` function to each element.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} items The array of elements to search.
-* @param {(element: T, index: number, array: readonly T[]) => number} getValue A function that selects a numeric value from each element.
-* @returns {T | undefined} The element with the maximum value as determined by the `getValue` function,
+* @param items The array of elements to search.
+* @param getValue A function that selects a numeric value from each element.
+* @returns The element with the maximum value as determined by the `getValue` function,
 * or `undefined` if the array is empty.
 * @example
 * maxBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 3 }

package/dist/array/maxBy.mjs

@@ -4,9 +4,9 @@
 * the `getValue` function to each element.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} items The array of elements to search.
-* @param {(element: T, index: number, array: readonly T[]) => number} getValue A function that selects a numeric value from each element.
-* @returns {T | undefined} The element with the maximum value as determined by the `getValue` function,
+* @param items The array of elements to search.
+* @param getValue A function that selects a numeric value from each element.
+* @returns The element with the maximum value as determined by the `getValue` function,
 * or `undefined` if the array is empty.
 * @example
 * maxBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 3 }

package/dist/array/minBy.d.mts

@@ -4,9 +4,9 @@
  * the `getValue` function to each element.
  *
  * @template T - The type of elements in the array.
- * @param {[T, ...T[]]} items The nonempty array of elements to search.
- * @param {(element: T) => number} getValue A function that selects a numeric value from each element.
- * @returns {T} The element with the minimum value as determined by the `getValue` function.
+ * @param items The nonempty array of elements to search.
+ * @param getValue A function that selects a numeric value from each element.
+ * @returns The element with the minimum value as determined by the `getValue` function.
  * @example
  * minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 1 }
  * minBy([], x => x.a); // Returns: undefined
@@ -25,9 +25,9 @@ declare function minBy<T>(items: readonly [T, ...T[]], getValue: (element: T, in
  * the `getValue` function to each element.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} items The array of elements to search.
- * @param {(element: T, index: number, array: readonly T[]) => number} getValue A function that selects a numeric value from each element.
- * @returns {T | undefined} The element with the minimum value as determined by the `getValue` function,
+ * @param items The array of elements to search.
+ * @param getValue A function that selects a numeric value from each element.
+ * @returns The element with the minimum value as determined by the `getValue` function,
  * or `undefined` if the array is empty.
  * @example
  * minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 1 }

package/dist/array/minBy.d.ts

@@ -4,9 +4,9 @@
  * the `getValue` function to each element.
  *
  * @template T - The type of elements in the array.
- * @param {[T, ...T[]]} items The nonempty array of elements to search.
- * @param {(element: T) => number} getValue A function that selects a numeric value from each element.
- * @returns {T} The element with the minimum value as determined by the `getValue` function.
+ * @param items The nonempty array of elements to search.
+ * @param getValue A function that selects a numeric value from each element.
+ * @returns The element with the minimum value as determined by the `getValue` function.
  * @example
  * minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 1 }
  * minBy([], x => x.a); // Returns: undefined
@@ -25,9 +25,9 @@ declare function minBy<T>(items: readonly [T, ...T[]], getValue: (element: T, in
  * the `getValue` function to each element.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} items The array of elements to search.
- * @param {(element: T, index: number, array: readonly T[]) => number} getValue A function that selects a numeric value from each element.
- * @returns {T | undefined} The element with the minimum value as determined by the `getValue` function,
+ * @param items The array of elements to search.
+ * @param getValue A function that selects a numeric value from each element.
+ * @returns The element with the minimum value as determined by the `getValue` function,
  * or `undefined` if the array is empty.
  * @example
  * minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 1 }

package/dist/array/minBy.js

@@ -4,9 +4,9 @@
 * the `getValue` function to each element.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} items The array of elements to search.
-* @param {(element: T, index: number, array: readonly T[]) => number} getValue A function that selects a numeric value from each element.
-* @returns {T | undefined} The element with the minimum value as determined by the `getValue` function,
+* @param items The array of elements to search.
+* @param getValue A function that selects a numeric value from each element.
+* @returns The element with the minimum value as determined by the `getValue` function,
 * or `undefined` if the array is empty.
 * @example
 * minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 1 }

package/dist/array/minBy.mjs

@@ -4,9 +4,9 @@
 * the `getValue` function to each element.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} items The array of elements to search.
-* @param {(element: T, index: number, array: readonly T[]) => number} getValue A function that selects a numeric value from each element.
-* @returns {T | undefined} The element with the minimum value as determined by the `getValue` function,
+* @param items The array of elements to search.
+* @param getValue A function that selects a numeric value from each element.
+* @returns The element with the minimum value as determined by the `getValue` function,
 * or `undefined` if the array is empty.
 * @example
 * minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 1 }

package/dist/array/orderBy.d.mts

@@ -10,10 +10,10 @@
  * If the number of orders is less than the number of criteria, it uses the last order for the rest of the criteria.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr - The array of objects to be sorted.
- * @param {Array<((item: T) => unknown) | keyof T>} criteria  - The criteria for sorting. This can be an array of object keys or functions that return values used for sorting.
- * @param {Array<'asc' | 'desc'>} orders - An array of order directions ('asc' for ascending or 'desc' for descending).
- * @returns {T[]} - The sorted array.
+ * @param arr - The array of objects to be sorted.
+ * @param criteria  - The criteria for sorting. This can be an array of object keys or functions that return values used for sorting.
+ * @param orders - An array of order directions ('asc' for ascending or 'desc' for descending).
+ * @returns The sorted array.
  *
  * @example
  * // Sort an array of objects by 'user' in ascending order and 'age' in descending order.