es-toolkit 1.39.10-dev.1598 → 1.39.10-dev.1600

package/dist/compat/function/attempt.d.mts

@@ -3,11 +3,11 @@
  * If the function throws an error, it catches the error and returns it.
  * If the caught error is not an instance of Error, it wraps it in a new Error.
  *
- * @param {F} func - The function to be executed.
- * @param {...Parameters<F>} args - The arguments to pass to the function.
- * @returns {ReturnType<F> | Error} The return value of the function if successful, or an Error if an exception is thrown.
+ * @param {(...args: any[]) => R} func - The function to be executed.
+ * @param {...any[]} args - The arguments to pass to the function.
+ * @returns {R | Error} The return value of the function if successful, or an Error if an exception is thrown.
  *
- * @template F - The type of the function being attempted.
+ * @template R - The type of the function return value.
  *
  * @example
  * // Example 1: Successful execution

package/dist/compat/function/attempt.d.ts

@@ -3,11 +3,11 @@
  * If the function throws an error, it catches the error and returns it.
  * If the caught error is not an instance of Error, it wraps it in a new Error.
  *
- * @param {F} func - The function to be executed.
- * @param {...Parameters<F>} args - The arguments to pass to the function.
- * @returns {ReturnType<F> | Error} The return value of the function if successful, or an Error if an exception is thrown.
+ * @param {(...args: any[]) => R} func - The function to be executed.
+ * @param {...any[]} args - The arguments to pass to the function.
+ * @returns {R | Error} The return value of the function if successful, or an Error if an exception is thrown.
  *
- * @template F - The type of the function being attempted.
+ * @template R - The type of the function return value.
  *
  * @example
  * // Example 1: Successful execution

package/dist/compat/function/bind.d.mts

@@ -5,11 +5,10 @@
  *
  * Note: Unlike native `Function#bind`, this method doesn't set the `length` property of bound functions.
  *
- * @template F - The type of the function to bind.
- * @param {F} func - The function to bind.
- * @param {unknown} thisObj - The `this` binding of `func`.
+ * @param {(...args: any[]) => any} func - The function to bind.
+ * @param {any} thisObj - The `this` binding of `func`.
  * @param {...any} partialArgs - The arguments to be partially applied.
- * @returns {F} - Returns the new bound function.
+ * @returns {(...args: any[]) => any} - Returns the new bound function.
  *
  * @example
  * function greet(greeting, punctuation) {

package/dist/compat/function/bind.d.ts

@@ -5,11 +5,10 @@
  *
  * Note: Unlike native `Function#bind`, this method doesn't set the `length` property of bound functions.
  *
- * @template F - The type of the function to bind.
- * @param {F} func - The function to bind.
- * @param {unknown} thisObj - The `this` binding of `func`.
+ * @param {(...args: any[]) => any} func - The function to bind.
+ * @param {any} thisObj - The `this` binding of `func`.
  * @param {...any} partialArgs - The arguments to be partially applied.
- * @returns {F} - Returns the new bound function.
+ * @returns {(...args: any[]) => any} - Returns the new bound function.
  *
  * @example
  * function greet(greeting, punctuation) {

package/dist/compat/function/overArgs.d.mts

@@ -12,15 +12,13 @@ import { Many } from '../_internal/Many.mjs';
  * If a transform is nullish, the identity function is used instead.
  * Only transforms arguments up to the number of transform functions provided.
  *
- * @template F - The type of the function to wrap
- * @template T - The type of the transform functions array
- * @param {F} func - The function to wrap
- * @param {T} transforms - The functions to transform arguments. Each transform can be:
+ * @param {(...args: any[]) => any} func - The function to wrap
+ * @param {Array<Many<(...args: any[]) => any>>} transforms - The functions to transform arguments. Each transform can be:
  *   - A function that accepts and returns a value
  *   - A string to get a property value (e.g. 'name' gets the name property)
  *   - An object to check if arguments match its properties
  *   - An array of [property, value] to check property matches
- * @returns {(...args: any[]) => ReturnType<F>} A new function that transforms arguments before passing them to func
+ * @returns {(...args: any[]) => any} A new function that transforms arguments before passing them to func
  * @throws {TypeError} If func is not a function.
  * @example
  * ```ts

package/dist/compat/function/overArgs.d.ts

@@ -12,15 +12,13 @@ import { Many } from '../_internal/Many.js';
  * If a transform is nullish, the identity function is used instead.
  * Only transforms arguments up to the number of transform functions provided.
  *
- * @template F - The type of the function to wrap
- * @template T - The type of the transform functions array
- * @param {F} func - The function to wrap
- * @param {T} transforms - The functions to transform arguments. Each transform can be:
+ * @param {(...args: any[]) => any} func - The function to wrap
+ * @param {Array<Many<(...args: any[]) => any>>} transforms - The functions to transform arguments. Each transform can be:
  *   - A function that accepts and returns a value
  *   - A string to get a property value (e.g. 'name' gets the name property)
  *   - An object to check if arguments match its properties
  *   - An array of [property, value] to check property matches
- * @returns {(...args: any[]) => ReturnType<F>} A new function that transforms arguments before passing them to func
+ * @returns {(...args: any[]) => any} A new function that transforms arguments before passing them to func
  * @throws {TypeError} If func is not a function.
  * @example
  * ```ts

package/dist/compat/function/rearg.d.mts

@@ -5,10 +5,9 @@ import { Many } from '../_internal/Many.mjs';
  * where the argument value at the first index is provided as the first argument,
  * the argument value at the second index is provided as the second argument, and so on.
  *
- * @template F The type of the function to re-arrange.
- * @param {F} func The function to rearrange arguments for.
+ * @param {(...args: any[]) => any} func The function to rearrange arguments for.
  * @param {Array<number | number[]>} indices The arranged argument indices.
- * @returns {(...args: any[]) => ReturnType<F>} Returns the new function.
+ * @returns {(...args: any[]) => any} Returns the new function.
  *
  * @example
  * const greet = (greeting: string, name: string) => `${greeting}, ${name}!`;

package/dist/compat/function/rearg.d.ts

@@ -5,10 +5,9 @@ import { Many } from '../_internal/Many.js';
  * where the argument value at the first index is provided as the first argument,
  * the argument value at the second index is provided as the second argument, and so on.
  *
- * @template F The type of the function to re-arrange.
- * @param {F} func The function to rearrange arguments for.
+ * @param {(...args: any[]) => any} func The function to rearrange arguments for.
  * @param {Array<number | number[]>} indices The arranged argument indices.
- * @returns {(...args: any[]) => ReturnType<F>} Returns the new function.
+ * @returns {(...args: any[]) => any} Returns the new function.
  *
  * @example
  * const greet = (greeting: string, name: string) => `${greeting}, ${name}!`;

package/dist/compat/function/rest.d.mts

@@ -3,11 +3,10 @@
  * The transformed arguments are passed to `func` such that the arguments starting from a specified index
  * are grouped into an array, while the previous arguments are passed as individual elements.
  *
- * @template F - The type of the function being transformed.
- * @param {F} func - The function whose arguments are to be transformed.
+ * @param {(...args: any[]) => any} func - The function whose arguments are to be transformed.
  * @param {number} [start=func.length - 1] - The index from which to start grouping the remaining arguments into an array.
  *                                            Defaults to `func.length - 1`, grouping all arguments after the last parameter.
- * @returns {(...args: any[]) => ReturnType<F>} A new function that, when called, returns the result of calling `func` with the transformed arguments.
+ * @returns {(...args: any[]) => any} A new function that, when called, returns the result of calling `func` with the transformed arguments.
  *
  * The transformed arguments are:
  * - The first `start` arguments as individual elements.

package/dist/compat/function/rest.d.ts

@@ -3,11 +3,10 @@
  * The transformed arguments are passed to `func` such that the arguments starting from a specified index
  * are grouped into an array, while the previous arguments are passed as individual elements.
  *
- * @template F - The type of the function being transformed.
- * @param {F} func - The function whose arguments are to be transformed.
+ * @param {(...args: any[]) => any} func - The function whose arguments are to be transformed.
  * @param {number} [start=func.length - 1] - The index from which to start grouping the remaining arguments into an array.
  *                                            Defaults to `func.length - 1`, grouping all arguments after the last parameter.
- * @returns {(...args: any[]) => ReturnType<F>} A new function that, when called, returns the result of calling `func` with the transformed arguments.
+ * @returns {(...args: any[]) => any} A new function that, when called, returns the result of calling `func` with the transformed arguments.
  *
  * The transformed arguments are:
  * - The first `start` arguments as individual elements.

package/dist/compat/function/wrap.d.mts

@@ -4,6 +4,13 @@
  *
  * If a `value` is provided instead of a function, this value is passed as the first argument to the `wrapper` function.
  *
+ * @template T - The type of the value being wrapped.
+ * @template U - The type of the arguments being passed to the `wrapper` function.
+ * @template V - The type of the return value of the `wrapper` function.
+ * @param {T} value - The value to be wrapped.
+ * @param {(value: T, ...args: U[]) => V} wrapper - The function to wrap the value with.
+ * @returns {(...args: U[]) => V} A new function that wraps the value with the `wrapper` function.
+ *
  * @example
  * // Wrap a function
  * const greet = (name: string) => `Hi, ${name}`;

package/dist/compat/function/wrap.d.ts

@@ -4,6 +4,13 @@
  *
  * If a `value` is provided instead of a function, this value is passed as the first argument to the `wrapper` function.
  *
+ * @template T - The type of the value being wrapped.
+ * @template U - The type of the arguments being passed to the `wrapper` function.
+ * @template V - The type of the return value of the `wrapper` function.
+ * @param {T} value - The value to be wrapped.
+ * @param {(value: T, ...args: U[]) => V} wrapper - The function to wrap the value with.
+ * @returns {(...args: U[]) => V} A new function that wraps the value with the `wrapper` function.
+ *
  * @example
  * // Wrap a function
  * const greet = (name: string) => `Hi, ${name}`;

package/dist/math/sumBy.d.mts

@@ -5,14 +5,15 @@
  * If the array is empty, this function returns `0`.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} items An array to calculate the sum.
- * @param {(element: T) => number} getValue A function that selects a numeric value from each element.
+ * @param {readonly T[]} items - An array to calculate the sum.
+ * @param {(element: T, index: number) => number} getValue - A function that selects a numeric value from each element.
+ *   It receives the element and its zero‑based index in the array.
  * @returns {number} The sum of all the numbers as determined by the `getValue` function.
  *
  * @example
- * sumBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: 6
- * sumBy([], x => x.a); // Returns: 0
+ * sumBy([{ a: 1 }, { a: 2 }, { a: 3 }], (x, i) => x.a * i); // Returns: 8
+ * sumBy([], () => 1); // Returns: 0
  */
-declare function sumBy<T>(items: readonly T[], getValue: (element: T) => number): number;
+declare function sumBy<T>(items: readonly T[], getValue: (element: T, index: number) => number): number;
 
 export { sumBy };

package/dist/math/sumBy.d.ts

@@ -5,14 +5,15 @@
  * If the array is empty, this function returns `0`.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} items An array to calculate the sum.
- * @param {(element: T) => number} getValue A function that selects a numeric value from each element.
+ * @param {readonly T[]} items - An array to calculate the sum.
+ * @param {(element: T, index: number) => number} getValue - A function that selects a numeric value from each element.
+ *   It receives the element and its zero‑based index in the array.
  * @returns {number} The sum of all the numbers as determined by the `getValue` function.
  *
  * @example
- * sumBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: 6
- * sumBy([], x => x.a); // Returns: 0
+ * sumBy([{ a: 1 }, { a: 2 }, { a: 3 }], (x, i) => x.a * i); // Returns: 8
+ * sumBy([], () => 1); // Returns: 0
  */
-declare function sumBy<T>(items: readonly T[], getValue: (element: T) => number): number;
+declare function sumBy<T>(items: readonly T[], getValue: (element: T, index: number) => number): number;
 
 export { sumBy };

package/dist/math/sumBy.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 function sumBy(items, getValue) {
     let result = 0;
     for (let i = 0; i < items.length; i++) {
-        result += getValue(items[i]);
+        result += getValue(items[i], i);
     }
     return result;
 }

package/dist/math/sumBy.mjs

@@ -1,7 +1,7 @@
 function sumBy(items, getValue) {
     let result = 0;
     for (let i = 0; i < items.length; i++) {
-        result += getValue(items[i]);
+        result += getValue(items[i], i);
     }
     return result;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "es-toolkit",
-  "version": "1.39.10-dev.1598+9e1549e6",
+  "version": "1.39.10-dev.1600+579af7b1",
   "description": "A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.",
   "homepage": "https://es-toolkit.dev",
   "bugs": "https://github.com/toss/es-toolkit/issues",