es-toolkit 1.47.0-dev.1840 → 1.47.0-dev.1842

package/dist/array/orderBy.d.ts

@@ -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.

package/dist/array/orderBy.js

@@ -11,10 +11,10 @@ const require_compareValues = require("../_internal/compareValues.js");
 * 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.

package/dist/array/orderBy.mjs

@@ -11,10 +11,10 @@ import { compareValues } from "../_internal/compareValues.mjs";
 * 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.

package/dist/array/partition.d.mts

@@ -8,11 +8,11 @@
  *
  * @template T - The type of elements in the array.
  * @template {T} U - The type being filtered for.
- * @param {T[]} arr - The array to partition.
- * @param {(value: T, index: number, array: readonly T[]) => value is U} isInTruthy - A type guard that determines whether an
+ * @param arr - The array to partition.
+ * @param isInTruthy - A type guard that determines whether an
  * element should be placed in the truthy array. The function is called with each element
  * of the array and its index.
- * @returns {[U[], Exclude<T, U>[]]} A tuple containing two arrays: the first array contains elements for
+ * @returns A tuple containing two arrays: the first array contains elements for
  * which the predicate returned true, and the second array contains elements for which the
  * predicate returned false.
  *
@@ -31,11 +31,11 @@ declare function partition<T, U extends T>(arr: readonly T[], isInTruthy: (value
  * the second array contains elements for which the predicate function returns false.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr - The array to partition.
- * @param {(value: T, index: number) => boolean} isInTruthy - A predicate function that determines
+ * @param arr - The array to partition.
+ * @param isInTruthy - A predicate function that determines
  * whether an element should be placed in the truthy array. The function is called with each
  * element of the array and its index.
- * @returns {[T[], T[]]} A tuple containing two arrays: the first array contains elements for
+ * @returns A tuple containing two arrays: the first array contains elements for
  * which the predicate returned true, and the second array contains elements for which the
  * predicate returned false.
  *

package/dist/array/partition.d.ts

@@ -8,11 +8,11 @@
  *
  * @template T - The type of elements in the array.
  * @template {T} U - The type being filtered for.
- * @param {T[]} arr - The array to partition.
- * @param {(value: T, index: number, array: readonly T[]) => value is U} isInTruthy - A type guard that determines whether an
+ * @param arr - The array to partition.
+ * @param isInTruthy - A type guard that determines whether an
  * element should be placed in the truthy array. The function is called with each element
  * of the array and its index.
- * @returns {[U[], Exclude<T, U>[]]} A tuple containing two arrays: the first array contains elements for
+ * @returns A tuple containing two arrays: the first array contains elements for
  * which the predicate returned true, and the second array contains elements for which the
  * predicate returned false.
  *
@@ -31,11 +31,11 @@ declare function partition<T, U extends T>(arr: readonly T[], isInTruthy: (value
  * the second array contains elements for which the predicate function returns false.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr - The array to partition.
- * @param {(value: T, index: number) => boolean} isInTruthy - A predicate function that determines
+ * @param arr - The array to partition.
+ * @param isInTruthy - A predicate function that determines
  * whether an element should be placed in the truthy array. The function is called with each
  * element of the array and its index.
- * @returns {[T[], T[]]} A tuple containing two arrays: the first array contains elements for
+ * @returns A tuple containing two arrays: the first array contains elements for
  * which the predicate returned true, and the second array contains elements for which the
  * predicate returned false.
  *

package/dist/array/pull.d.mts

@@ -6,9 +6,9 @@
  * If you want to remove values without modifying the original array, use `difference`.
  *
  * @template T
- * @param {T[]} arr - The array to modify.
- * @param {unknown[]} valuesToRemove - The values to remove from the array.
- * @returns {T[]} The modified array with the specified values removed.
+ * @param arr - The array to modify.
+ * @param valuesToRemove - The values to remove from the array.
+ * @returns The modified array with the specified values removed.
  *
  * @example
  * const numbers = [1, 2, 3, 4, 5, 2, 4];

package/dist/array/pull.d.ts

@@ -6,9 +6,9 @@
  * If you want to remove values without modifying the original array, use `difference`.
  *
  * @template T
- * @param {T[]} arr - The array to modify.
- * @param {unknown[]} valuesToRemove - The values to remove from the array.
- * @returns {T[]} The modified array with the specified values removed.
+ * @param arr - The array to modify.
+ * @param valuesToRemove - The values to remove from the array.
+ * @returns The modified array with the specified values removed.
  *
  * @example
  * const numbers = [1, 2, 3, 4, 5, 2, 4];

package/dist/array/pull.js

@@ -6,9 +6,9 @@
 * If you want to remove values without modifying the original array, use `difference`.
 *
 * @template T
-* @param {T[]} arr - The array to modify.
-* @param {unknown[]} valuesToRemove - The values to remove from the array.
-* @returns {T[]} The modified array with the specified values removed.
+* @param arr - The array to modify.
+* @param valuesToRemove - The values to remove from the array.
+* @returns The modified array with the specified values removed.
 *
 * @example
 * const numbers = [1, 2, 3, 4, 5, 2, 4];

package/dist/array/pull.mjs

@@ -6,9 +6,9 @@
 * If you want to remove values without modifying the original array, use `difference`.
 *
 * @template T
-* @param {T[]} arr - The array to modify.
-* @param {unknown[]} valuesToRemove - The values to remove from the array.
-* @returns {T[]} The modified array with the specified values removed.
+* @param arr - The array to modify.
+* @param valuesToRemove - The values to remove from the array.
+* @returns The modified array with the specified values removed.
 *
 * @example
 * const numbers = [1, 2, 3, 4, 5, 2, 4];

package/dist/array/pullAt.d.mts

@@ -5,9 +5,9 @@
  * This function supports negative indices, which count from the end of the array.
  *
  * @template T
- * @param {T[]} arr - The array from which elements will be removed.
- * @param {number[]} indicesToRemove - An array of indices specifying the positions of elements to remove.
- * @returns {Array<T | undefined>} An array containing the elements that were removed from the original array.
+ * @param arr - The array from which elements will be removed.
+ * @param indicesToRemove - An array of indices specifying the positions of elements to remove.
+ * @returns An array containing the elements that were removed from the original array.
  *
  * @example
  * const numbers = [10, 20, 30, 40, 50];

package/dist/array/pullAt.d.ts

@@ -5,9 +5,9 @@
  * This function supports negative indices, which count from the end of the array.
  *
  * @template T
- * @param {T[]} arr - The array from which elements will be removed.
- * @param {number[]} indicesToRemove - An array of indices specifying the positions of elements to remove.
- * @returns {Array<T | undefined>} An array containing the elements that were removed from the original array.
+ * @param arr - The array from which elements will be removed.
+ * @param indicesToRemove - An array of indices specifying the positions of elements to remove.
+ * @returns An array containing the elements that were removed from the original array.
  *
  * @example
  * const numbers = [10, 20, 30, 40, 50];

package/dist/array/pullAt.js

@@ -6,9 +6,9 @@ const require_at = require("./at.js");
 * This function supports negative indices, which count from the end of the array.
 *
 * @template T
-* @param {T[]} arr - The array from which elements will be removed.
-* @param {number[]} indicesToRemove - An array of indices specifying the positions of elements to remove.
-* @returns {Array<T | undefined>} An array containing the elements that were removed from the original array.
+* @param arr - The array from which elements will be removed.
+* @param indicesToRemove - An array of indices specifying the positions of elements to remove.
+* @returns An array containing the elements that were removed from the original array.
 *
 * @example
 * const numbers = [10, 20, 30, 40, 50];

package/dist/array/pullAt.mjs

@@ -6,9 +6,9 @@ import { at } from "./at.mjs";
 * This function supports negative indices, which count from the end of the array.
 *
 * @template T
-* @param {T[]} arr - The array from which elements will be removed.
-* @param {number[]} indicesToRemove - An array of indices specifying the positions of elements to remove.
-* @returns {Array<T | undefined>} An array containing the elements that were removed from the original array.
+* @param arr - The array from which elements will be removed.
+* @param indicesToRemove - An array of indices specifying the positions of elements to remove.
+* @returns An array containing the elements that were removed from the original array.
 *
 * @example
 * const numbers = [10, 20, 30, 40, 50];

package/dist/array/reduceAsync.d.mts

@@ -9,10 +9,10 @@
  *
  * @template T - The type of elements in the array.
  * @template U - The type of the accumulated result.
- * @param {readonly T[]} array The array to reduce.
- * @param {(accumulator: U, currentValue: T, currentIndex: number, array: readonly T[]) => Promise<U>} reducer An async function that processes each element.
- * @param {U} initialValue The initial value of the accumulator.
- * @returns {Promise<U>} A promise that resolves to the final accumulated value.
+ * @param array The array to reduce.
+ * @param reducer An async function that processes each element.
+ * @param initialValue The initial value of the accumulator.
+ * @returns A promise that resolves to the final accumulated value.
  * @example
  * const numbers = [1, 2, 3, 4, 5];
  * const sum = await reduceAsync(
@@ -48,9 +48,9 @@ declare function reduceAsync<T, U>(array: readonly T[], reducer: (accumulator: U
  * the initial value and the reduction starts from the second element.
  *
  * @template T - The type of elements in the array.
- * @param {readonly T[]} array The array to reduce.
- * @param {(accumulator: T, currentValue: T, currentIndex: number, array: readonly T[]) => Promise<T>} reducer An async function that processes each element.
- * @returns {Promise<T | undefined>} A promise that resolves to the final accumulated value, or undefined if the array is empty.
+ * @param array The array to reduce.
+ * @param reducer An async function that processes each element.
+ * @returns A promise that resolves to the final accumulated value, or undefined if the array is empty.
  * @example
  * const numbers = [1, 2, 3, 4, 5];
  * const sum = await reduceAsync(

package/dist/array/reduceAsync.d.ts

@@ -9,10 +9,10 @@
  *
  * @template T - The type of elements in the array.
  * @template U - The type of the accumulated result.
- * @param {readonly T[]} array The array to reduce.
- * @param {(accumulator: U, currentValue: T, currentIndex: number, array: readonly T[]) => Promise<U>} reducer An async function that processes each element.
- * @param {U} initialValue The initial value of the accumulator.
- * @returns {Promise<U>} A promise that resolves to the final accumulated value.
+ * @param array The array to reduce.
+ * @param reducer An async function that processes each element.
+ * @param initialValue The initial value of the accumulator.
+ * @returns A promise that resolves to the final accumulated value.
  * @example
  * const numbers = [1, 2, 3, 4, 5];
  * const sum = await reduceAsync(
@@ -48,9 +48,9 @@ declare function reduceAsync<T, U>(array: readonly T[], reducer: (accumulator: U
  * the initial value and the reduction starts from the second element.
  *
  * @template T - The type of elements in the array.
- * @param {readonly T[]} array The array to reduce.
- * @param {(accumulator: T, currentValue: T, currentIndex: number, array: readonly T[]) => Promise<T>} reducer An async function that processes each element.
- * @returns {Promise<T | undefined>} A promise that resolves to the final accumulated value, or undefined if the array is empty.
+ * @param array The array to reduce.
+ * @param reducer An async function that processes each element.
+ * @returns A promise that resolves to the final accumulated value, or undefined if the array is empty.
  * @example
  * const numbers = [1, 2, 3, 4, 5];
  * const sum = await reduceAsync(

package/dist/array/remove.d.mts

@@ -6,9 +6,9 @@
  * If you want to remove elements without modifying the original array, use `filter`.
  *
  * @template T
- * @param {T[]} arr - The array to modify.
- * @param {(value: T, index: number, array: T[]) => boolean} shouldRemoveElement - The function invoked per iteration to determine if an element should be removed.
- * @returns {T[]} The modified array with the specified elements removed.
+ * @param arr - The array to modify.
+ * @param shouldRemoveElement - The function invoked per iteration to determine if an element should be removed.
+ * @returns The modified array with the specified elements removed.
  *
  * @example
  * const numbers = [1, 2, 3, 4, 5];

package/dist/array/remove.d.ts

@@ -6,9 +6,9 @@
  * If you want to remove elements without modifying the original array, use `filter`.
  *
  * @template T
- * @param {T[]} arr - The array to modify.
- * @param {(value: T, index: number, array: T[]) => boolean} shouldRemoveElement - The function invoked per iteration to determine if an element should be removed.
- * @returns {T[]} The modified array with the specified elements removed.
+ * @param arr - The array to modify.
+ * @param shouldRemoveElement - The function invoked per iteration to determine if an element should be removed.
+ * @returns The modified array with the specified elements removed.
  *
  * @example
  * const numbers = [1, 2, 3, 4, 5];

package/dist/array/remove.js

@@ -6,9 +6,9 @@
 * If you want to remove elements without modifying the original array, use `filter`.
 *
 * @template T
-* @param {T[]} arr - The array to modify.
-* @param {(value: T, index: number, array: T[]) => boolean} shouldRemoveElement - The function invoked per iteration to determine if an element should be removed.
-* @returns {T[]} The modified array with the specified elements removed.
+* @param arr - The array to modify.
+* @param shouldRemoveElement - The function invoked per iteration to determine if an element should be removed.
+* @returns The modified array with the specified elements removed.
 *
 * @example
 * const numbers = [1, 2, 3, 4, 5];

package/dist/array/remove.mjs

@@ -6,9 +6,9 @@
 * If you want to remove elements without modifying the original array, use `filter`.
 *
 * @template T
-* @param {T[]} arr - The array to modify.
-* @param {(value: T, index: number, array: T[]) => boolean} shouldRemoveElement - The function invoked per iteration to determine if an element should be removed.
-* @returns {T[]} The modified array with the specified elements removed.
+* @param arr - The array to modify.
+* @param shouldRemoveElement - The function invoked per iteration to determine if an element should be removed.
+* @returns The modified array with the specified elements removed.
 *
 * @example
 * const numbers = [1, 2, 3, 4, 5];

package/dist/array/sample.d.mts

@@ -5,8 +5,8 @@
  * This function takes an array and returns a single element selected randomly from the array.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr - The array to sample from.
- * @returns {T} A random element from the array.
+ * @param arr - The array to sample from.
+ * @returns A random element from the array.
  *
  * @example
  * const array = [1, 2, 3, 4, 5];

package/dist/array/sample.d.ts

@@ -5,8 +5,8 @@
  * This function takes an array and returns a single element selected randomly from the array.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr - The array to sample from.
- * @returns {T} A random element from the array.
+ * @param arr - The array to sample from.
+ * @returns A random element from the array.
  *
  * @example
  * const array = [1, 2, 3, 4, 5];

package/dist/array/sample.js

@@ -5,8 +5,8 @@
 * This function takes an array and returns a single element selected randomly from the array.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} arr - The array to sample from.
-* @returns {T} A random element from the array.
+* @param arr - The array to sample from.
+* @returns A random element from the array.
 *
 * @example
 * const array = [1, 2, 3, 4, 5];

package/dist/array/sample.mjs

@@ -5,8 +5,8 @@
 * This function takes an array and returns a single element selected randomly from the array.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} arr - The array to sample from.
-* @returns {T} A random element from the array.
+* @param arr - The array to sample from.
+* @returns A random element from the array.
 *
 * @example
 * const array = [1, 2, 3, 4, 5];

package/dist/array/sampleSize.d.mts

@@ -7,9 +7,9 @@
  * {@link https://www.nowherenearithaca.com/2013/05/robert-floyds-tiny-and-beautiful.html Floyd's algorithm}
  *
  * @template T - The type of elements in the array.
- * @param {T[]} array - The array to sample from.
- * @param {number} size - The size of sample.
- * @returns {T[]} A new array with sample size applied.
+ * @param array - The array to sample from.
+ * @param size - The size of sample.
+ * @returns A new array with sample size applied.
  * @throws {Error} Throws an error if `size` is greater than the length of `array`.
  *
  * @example

package/dist/array/sampleSize.d.ts

@@ -7,9 +7,9 @@
  * {@link https://www.nowherenearithaca.com/2013/05/robert-floyds-tiny-and-beautiful.html Floyd's algorithm}
  *
  * @template T - The type of elements in the array.
- * @param {T[]} array - The array to sample from.
- * @param {number} size - The size of sample.
- * @returns {T[]} A new array with sample size applied.
+ * @param array - The array to sample from.
+ * @param size - The size of sample.
+ * @returns A new array with sample size applied.
  * @throws {Error} Throws an error if `size` is greater than the length of `array`.
  *
  * @example

package/dist/array/sampleSize.js

@@ -8,9 +8,9 @@ const require_randomInt = require("../math/randomInt.js");
 * {@link https://www.nowherenearithaca.com/2013/05/robert-floyds-tiny-and-beautiful.html Floyd's algorithm}
 *
 * @template T - The type of elements in the array.
-* @param {T[]} array - The array to sample from.
-* @param {number} size - The size of sample.
-* @returns {T[]} A new array with sample size applied.
+* @param array - The array to sample from.
+* @param size - The size of sample.
+* @returns A new array with sample size applied.
 * @throws {Error} Throws an error if `size` is greater than the length of `array`.
 *
 * @example

package/dist/array/sampleSize.mjs

@@ -8,9 +8,9 @@ import { randomInt } from "../math/randomInt.mjs";
 * {@link https://www.nowherenearithaca.com/2013/05/robert-floyds-tiny-and-beautiful.html Floyd's algorithm}
 *
 * @template T - The type of elements in the array.
-* @param {T[]} array - The array to sample from.
-* @param {number} size - The size of sample.
-* @returns {T[]} A new array with sample size applied.
+* @param array - The array to sample from.
+* @param size - The size of sample.
+* @returns A new array with sample size applied.
 * @throws {Error} Throws an error if `size` is greater than the length of `array`.
 *
 * @example

package/dist/array/shuffle.d.mts

@@ -5,8 +5,8 @@
  * This function takes an array and returns a new array with its elements shuffled in a random order.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr - The array to shuffle.
- * @returns {T[]} A new array with its elements shuffled in random order.
+ * @param arr - The array to shuffle.
+ * @returns A new array with its elements shuffled in random order.
  *
  * @example
  * const array = [1, 2, 3, 4, 5];

package/dist/array/shuffle.d.ts

@@ -5,8 +5,8 @@
  * This function takes an array and returns a new array with its elements shuffled in a random order.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr - The array to shuffle.
- * @returns {T[]} A new array with its elements shuffled in random order.
+ * @param arr - The array to shuffle.
+ * @returns A new array with its elements shuffled in random order.
  *
  * @example
  * const array = [1, 2, 3, 4, 5];

package/dist/array/shuffle.js

@@ -5,8 +5,8 @@
 * This function takes an array and returns a new array with its elements shuffled in a random order.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} arr - The array to shuffle.
-* @returns {T[]} A new array with its elements shuffled in random order.
+* @param arr - The array to shuffle.
+* @returns A new array with its elements shuffled in random order.
 *
 * @example
 * const array = [1, 2, 3, 4, 5];

package/dist/array/shuffle.mjs

@@ -5,8 +5,8 @@
 * This function takes an array and returns a new array with its elements shuffled in a random order.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} arr - The array to shuffle.
-* @returns {T[]} A new array with its elements shuffled in random order.
+* @param arr - The array to shuffle.
+* @returns A new array with its elements shuffled in random order.
 *
 * @example
 * const array = [1, 2, 3, 4, 5];

package/dist/array/sortBy.d.mts

@@ -9,9 +9,9 @@
  * If two objects have the same value for the current criterion, it uses the next criterion to determine their order.
  *
  * @template T - The type of the objects 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.
- * @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.
+ * @returns The sorted array.
  *
  * @example
  * const users = [

package/dist/array/sortBy.d.ts

@@ -9,9 +9,9 @@
  * If two objects have the same value for the current criterion, it uses the next criterion to determine their order.
  *
  * @template T - The type of the objects 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.
- * @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.
+ * @returns The sorted array.
  *
  * @example
  * const users = [

package/dist/array/sortBy.js

@@ -10,9 +10,9 @@ const require_orderBy = require("./orderBy.js");
 * If two objects have the same value for the current criterion, it uses the next criterion to determine their order.
 *
 * @template T - The type of the objects 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.
-* @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.
+* @returns The sorted array.
 *
 * @example
 * const users = [

package/dist/array/sortBy.mjs

@@ -10,9 +10,9 @@ import { orderBy } from "./orderBy.mjs";
 * If two objects have the same value for the current criterion, it uses the next criterion to determine their order.
 *
 * @template T - The type of the objects 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.
-* @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.
+* @returns The sorted array.
 *
 * @example
 * const users = [

package/dist/array/tail.d.mts

@@ -3,8 +3,8 @@
  * Returns an empty array when the input is a single-element array.
  *
  * @template T - The type of the single element in the array.
- * @param {[T]} arr - The single-element array to process.
- * @returns {[]} An empty array.
+ * @param arr - The single-element array to process.
+ * @returns An empty array.
  *
  * @example
  * const arr = [1];
@@ -16,8 +16,8 @@ declare function tail<T>(arr: readonly [T]): [];
  * Returns an empty array when the input is an empty array.
  *
  * @template T - The type of elements in the array.
- * @param {[]} arr - The empty array to process.
- * @returns {[]} An empty array.
+ * @param arr - The empty array to process.
+ * @returns An empty array.
  *
  * @example
  * const arr = [];
@@ -30,8 +30,8 @@ declare function tail(arr: readonly []): [];
  *
  * @template T - The type of the first element in the tuple array.
  * @template U - The type of the remaining elements in the tuple array.
- * @param {[T, ...U[]]} arr - The tuple array to process.
- * @returns {U[]} A new array containing all elements of the input array except for the first one.
+ * @param arr - The tuple array to process.
+ * @returns A new array containing all elements of the input array except for the first one.
  *
  * @example
  * const arr = [1, 2, 3];
@@ -47,8 +47,8 @@ declare function tail<T, U>(arr: readonly [T, ...U[]]): U[];
  * an empty array is returned.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr - The array to get the tail of.
- * @returns {T[]} A new array containing all elements of the input array except for the first one.
+ * @param arr - The array to get the tail of.
+ * @returns A new array containing all elements of the input array except for the first one.
  *
  * @example
  * const arr1 = [1, 2, 3];