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

package/dist/map/hasValue.mjs

@@ -9,9 +9,9 @@ import { isEqualsSameValueZero } from "../_internal/isEqualsSameValueZero.mjs";
 *
 * @template K - The type of keys in the Map.
 * @template V - The type of values in the Map.
-* @param {Map<K, V>} map - The Map to search.
-* @param {V} searchElement - The value to search for.
-* @returns {boolean} true if the Map contains the value, false otherwise.
+* @param map - The Map to search.
+* @param searchElement - The value to search for.
+* @returns true if the Map contains the value, false otherwise.
 *
 * @example
 * const map = new Map([

package/dist/map/keyBy.d.mts

@@ -10,9 +10,9 @@
  * @template K - The type of keys in the original Map.
  * @template V - The type of values in the original Map.
  * @template K2 - The type of keys to produce in the returned Map.
- * @param {Map<K, V>} map - The map of entries to be mapped.
- * @param {(value: V, key: K, object: Map<K, V>) => K2} getKeyFromEntry - A function that generates a key from a value-key pair.
- * @returns {Map<K2, V>} A Map where the generated keys are mapped to each entry's value.
+ * @param map - The map of entries to be mapped.
+ * @param getKeyFromEntry - A function that generates a key from a value-key pair.
+ * @returns A Map where the generated keys are mapped to each entry's value.
  *
  * @example
  * const map = new Map([

package/dist/map/keyBy.d.ts

@@ -10,9 +10,9 @@
  * @template K - The type of keys in the original Map.
  * @template V - The type of values in the original Map.
  * @template K2 - The type of keys to produce in the returned Map.
- * @param {Map<K, V>} map - The map of entries to be mapped.
- * @param {(value: V, key: K, object: Map<K, V>) => K2} getKeyFromEntry - A function that generates a key from a value-key pair.
- * @returns {Map<K2, V>} A Map where the generated keys are mapped to each entry's value.
+ * @param map - The map of entries to be mapped.
+ * @param getKeyFromEntry - A function that generates a key from a value-key pair.
+ * @returns A Map where the generated keys are mapped to each entry's value.
  *
  * @example
  * const map = new Map([

package/dist/map/keyBy.js

@@ -10,9 +10,9 @@
 * @template K - The type of keys in the original Map.
 * @template V - The type of values in the original Map.
 * @template K2 - The type of keys to produce in the returned Map.
-* @param {Map<K, V>} map - The map of entries to be mapped.
-* @param {(value: V, key: K, object: Map<K, V>) => K2} getKeyFromEntry - A function that generates a key from a value-key pair.
-* @returns {Map<K2, V>} A Map where the generated keys are mapped to each entry's value.
+* @param map - The map of entries to be mapped.
+* @param getKeyFromEntry - A function that generates a key from a value-key pair.
+* @returns A Map where the generated keys are mapped to each entry's value.
 *
 * @example
 * const map = new Map([

package/dist/map/keyBy.mjs

@@ -10,9 +10,9 @@
 * @template K - The type of keys in the original Map.
 * @template V - The type of values in the original Map.
 * @template K2 - The type of keys to produce in the returned Map.
-* @param {Map<K, V>} map - The map of entries to be mapped.
-* @param {(value: V, key: K, object: Map<K, V>) => K2} getKeyFromEntry - A function that generates a key from a value-key pair.
-* @returns {Map<K2, V>} A Map where the generated keys are mapped to each entry's value.
+* @param map - The map of entries to be mapped.
+* @param getKeyFromEntry - A function that generates a key from a value-key pair.
+* @returns A Map where the generated keys are mapped to each entry's value.
 *
 * @example
 * const map = new Map([

package/dist/map/mapKeys.d.mts

@@ -8,9 +8,9 @@
  *
  * @template K - The type of keys in the Map.
  * @template V - The type of values in the Map.
- * @param {Map<K, V>} map - The Map to transform.
- * @param {(value: V, key: K, object: Map<K, V>) => K} getNewKey - A function that generates a new key from a value-key pair.
- * @returns {Map<K, V>} A new Map with transformed keys and the same values.
+ * @param map - The Map to transform.
+ * @param getNewKey - A function that generates a new key from a value-key pair.
+ * @returns A new Map with transformed keys and the same values.
  *
  * @example
  * const map = new Map([

package/dist/map/mapKeys.d.ts

@@ -8,9 +8,9 @@
  *
  * @template K - The type of keys in the Map.
  * @template V - The type of values in the Map.
- * @param {Map<K, V>} map - The Map to transform.
- * @param {(value: V, key: K, object: Map<K, V>) => K} getNewKey - A function that generates a new key from a value-key pair.
- * @returns {Map<K, V>} A new Map with transformed keys and the same values.
+ * @param map - The Map to transform.
+ * @param getNewKey - A function that generates a new key from a value-key pair.
+ * @returns A new Map with transformed keys and the same values.
  *
  * @example
  * const map = new Map([

package/dist/map/mapKeys.js

@@ -8,9 +8,9 @@
 *
 * @template K - The type of keys in the Map.
 * @template V - The type of values in the Map.
-* @param {Map<K, V>} map - The Map to transform.
-* @param {(value: V, key: K, object: Map<K, V>) => K} getNewKey - A function that generates a new key from a value-key pair.
-* @returns {Map<K, V>} A new Map with transformed keys and the same values.
+* @param map - The Map to transform.
+* @param getNewKey - A function that generates a new key from a value-key pair.
+* @returns A new Map with transformed keys and the same values.
 *
 * @example
 * const map = new Map([

package/dist/map/mapKeys.mjs

@@ -8,9 +8,9 @@
 *
 * @template K - The type of keys in the Map.
 * @template V - The type of values in the Map.
-* @param {Map<K, V>} map - The Map to transform.
-* @param {(value: V, key: K, object: Map<K, V>) => K} getNewKey - A function that generates a new key from a value-key pair.
-* @returns {Map<K, V>} A new Map with transformed keys and the same values.
+* @param map - The Map to transform.
+* @param getNewKey - A function that generates a new key from a value-key pair.
+* @returns A new Map with transformed keys and the same values.
 *
 * @example
 * const map = new Map([

package/dist/map/mapValues.d.mts

@@ -8,9 +8,9 @@
  *
  * @template K - The type of keys in the Map.
  * @template V - The type of values in the Map.
- * @param {Map<K, V>} map - The Map to transform.
- * @param {(value: V, key: K, object: Map<K, V>) => V} getNewValue - A function that generates a new value from a value-key pair.
- * @returns {Map<K, V>} A new Map with the same keys and transformed values.
+ * @param map - The Map to transform.
+ * @param getNewValue - A function that generates a new value from a value-key pair.
+ * @returns A new Map with the same keys and transformed values.
  *
  * @example
  * const map = new Map([

package/dist/map/mapValues.d.ts

@@ -8,9 +8,9 @@
  *
  * @template K - The type of keys in the Map.
  * @template V - The type of values in the Map.
- * @param {Map<K, V>} map - The Map to transform.
- * @param {(value: V, key: K, object: Map<K, V>) => V} getNewValue - A function that generates a new value from a value-key pair.
- * @returns {Map<K, V>} A new Map with the same keys and transformed values.
+ * @param map - The Map to transform.
+ * @param getNewValue - A function that generates a new value from a value-key pair.
+ * @returns A new Map with the same keys and transformed values.
  *
  * @example
  * const map = new Map([

package/dist/map/mapValues.js

@@ -8,9 +8,9 @@
 *
 * @template K - The type of keys in the Map.
 * @template V - The type of values in the Map.
-* @param {Map<K, V>} map - The Map to transform.
-* @param {(value: V, key: K, object: Map<K, V>) => V} getNewValue - A function that generates a new value from a value-key pair.
-* @returns {Map<K, V>} A new Map with the same keys and transformed values.
+* @param map - The Map to transform.
+* @param getNewValue - A function that generates a new value from a value-key pair.
+* @returns A new Map with the same keys and transformed values.
 *
 * @example
 * const map = new Map([

package/dist/map/mapValues.mjs

@@ -8,9 +8,9 @@
 *
 * @template K - The type of keys in the Map.
 * @template V - The type of values in the Map.
-* @param {Map<K, V>} map - The Map to transform.
-* @param {(value: V, key: K, object: Map<K, V>) => V} getNewValue - A function that generates a new value from a value-key pair.
-* @returns {Map<K, V>} A new Map with the same keys and transformed values.
+* @param map - The Map to transform.
+* @param getNewValue - A function that generates a new value from a value-key pair.
+* @returns A new Map with the same keys and transformed values.
 *
 * @example
 * const map = new Map([

package/dist/map/reduce.d.mts

@@ -8,10 +8,10 @@
  *
  * @template K - The type of keys in the Map.
  * @template V - The type of values in the Map.
- * @param {Map<K, V>} map - The Map to reduce.
- * @param {(accumulator: V, value: V, key: K, map: Map<K, V>) => V} callback - A function that processes each entry and updates the accumulator.
- * @param {V} [initialValue] - The initial value for the accumulator. If not provided, the first value in the Map is used.
- * @returns {V} The final accumulated value.
+ * @param map - The Map to reduce.
+ * @param callback - A function that processes each entry and updates the accumulator.
+ * @param [initialValue] - The initial value for the accumulator. If not provided, the first value in the Map is used.
+ * @returns The final accumulated value.
  * @throws {TypeError} If the Map is empty and no initial value is provided.
  *
  * @example

package/dist/map/reduce.d.ts

@@ -8,10 +8,10 @@
  *
  * @template K - The type of keys in the Map.
  * @template V - The type of values in the Map.
- * @param {Map<K, V>} map - The Map to reduce.
- * @param {(accumulator: V, value: V, key: K, map: Map<K, V>) => V} callback - A function that processes each entry and updates the accumulator.
- * @param {V} [initialValue] - The initial value for the accumulator. If not provided, the first value in the Map is used.
- * @returns {V} The final accumulated value.
+ * @param map - The Map to reduce.
+ * @param callback - A function that processes each entry and updates the accumulator.
+ * @param [initialValue] - The initial value for the accumulator. If not provided, the first value in the Map is used.
+ * @returns The final accumulated value.
  * @throws {TypeError} If the Map is empty and no initial value is provided.
  *
  * @example

package/dist/map/reduce.js

@@ -8,10 +8,10 @@
 *
 * @template K - The type of keys in the Map.
 * @template V - The type of values in the Map.
-* @param {Map<K, V>} map - The Map to reduce.
-* @param {(accumulator: V, value: V, key: K, map: Map<K, V>) => V} callback - A function that processes each entry and updates the accumulator.
-* @param {V} [initialValue] - The initial value for the accumulator. If not provided, the first value in the Map is used.
-* @returns {V} The final accumulated value.
+* @param map - The Map to reduce.
+* @param callback - A function that processes each entry and updates the accumulator.
+* @param [initialValue] - The initial value for the accumulator. If not provided, the first value in the Map is used.
+* @returns The final accumulated value.
 * @throws {TypeError} If the Map is empty and no initial value is provided.
 *
 * @example

package/dist/map/reduce.mjs

@@ -8,10 +8,10 @@
 *
 * @template K - The type of keys in the Map.
 * @template V - The type of values in the Map.
-* @param {Map<K, V>} map - The Map to reduce.
-* @param {(accumulator: V, value: V, key: K, map: Map<K, V>) => V} callback - A function that processes each entry and updates the accumulator.
-* @param {V} [initialValue] - The initial value for the accumulator. If not provided, the first value in the Map is used.
-* @returns {V} The final accumulated value.
+* @param map - The Map to reduce.
+* @param callback - A function that processes each entry and updates the accumulator.
+* @param [initialValue] - The initial value for the accumulator. If not provided, the first value in the Map is used.
+* @returns The final accumulated value.
 * @throws {TypeError} If the Map is empty and no initial value is provided.
 *
 * @example

package/dist/map/some.d.mts

@@ -8,9 +8,9 @@
  *
  * @template K - The type of keys in the Map.
  * @template V - The type of values in the Map.
- * @param {Map<K, V>} map - The Map to test.
- * @param {(value: V, key: K, map: Map<K, V>) => boolean} doesMatch - A predicate function that tests each entry.
- * @returns {boolean} true if at least one entry satisfies the predicate, false otherwise.
+ * @param map - The Map to test.
+ * @param doesMatch - A predicate function that tests each entry.
+ * @returns true if at least one entry satisfies the predicate, false otherwise.
  *
  * @example
  * const map = new Map([

package/dist/map/some.d.ts

@@ -8,9 +8,9 @@
  *
  * @template K - The type of keys in the Map.
  * @template V - The type of values in the Map.
- * @param {Map<K, V>} map - The Map to test.
- * @param {(value: V, key: K, map: Map<K, V>) => boolean} doesMatch - A predicate function that tests each entry.
- * @returns {boolean} true if at least one entry satisfies the predicate, false otherwise.
+ * @param map - The Map to test.
+ * @param doesMatch - A predicate function that tests each entry.
+ * @returns true if at least one entry satisfies the predicate, false otherwise.
  *
  * @example
  * const map = new Map([

package/dist/map/some.js

@@ -8,9 +8,9 @@
 *
 * @template K - The type of keys in the Map.
 * @template V - The type of values in the Map.
-* @param {Map<K, V>} map - The Map to test.
-* @param {(value: V, key: K, map: Map<K, V>) => boolean} doesMatch - A predicate function that tests each entry.
-* @returns {boolean} true if at least one entry satisfies the predicate, false otherwise.
+* @param map - The Map to test.
+* @param doesMatch - A predicate function that tests each entry.
+* @returns true if at least one entry satisfies the predicate, false otherwise.
 *
 * @example
 * const map = new Map([

package/dist/map/some.mjs

@@ -8,9 +8,9 @@
 *
 * @template K - The type of keys in the Map.
 * @template V - The type of values in the Map.
-* @param {Map<K, V>} map - The Map to test.
-* @param {(value: V, key: K, map: Map<K, V>) => boolean} doesMatch - A predicate function that tests each entry.
-* @returns {boolean} true if at least one entry satisfies the predicate, false otherwise.
+* @param map - The Map to test.
+* @param doesMatch - A predicate function that tests each entry.
+* @returns true if at least one entry satisfies the predicate, false otherwise.
 *
 * @example
 * const map = new Map([

package/dist/math/clamp.d.mts

@@ -5,9 +5,9 @@
  * This function takes a number and a maximum bound, and returns the number clamped within the specified upper bound.
  * If only one bound is provided, it returns the minimum of the value and the bound.
  *
- * @param {number} value - The number to clamp.
- * @param {number} maximum - The maximum bound to clamp the number.
- * @returns {number} The clamped number within the specified upper bound.
+ * @param value - The number to clamp.
+ * @param maximum - The maximum bound to clamp the number.
+ * @returns The clamped number within the specified upper bound.
  *
  * @example
  * const result1 = clamp(10, 5); // result1 will be 5, as 10 is clamped to the bound 5
@@ -18,10 +18,10 @@ declare function clamp(value: number, maximum: number): number;
  *
  * This function takes a number and two bounds, and returns the number clamped within the specified bounds.
  *
- * @param {number} value - The number to clamp.
- * @param {number} minimum - The minimum bound to clamp the number.
- * @param {number} maximum - The maximum bound to clamp the number.
- * @returns {number} The clamped number within the specified bounds.
+ * @param value - The number to clamp.
+ * @param minimum - The minimum bound to clamp the number.
+ * @param maximum - The maximum bound to clamp the number.
+ * @returns The clamped number within the specified bounds.
  *
  * @example
  * const result2 = clamp(10, 5, 15); // result2 will be 10, as it is within the bounds 5 and 15

package/dist/math/clamp.d.ts

@@ -5,9 +5,9 @@
  * This function takes a number and a maximum bound, and returns the number clamped within the specified upper bound.
  * If only one bound is provided, it returns the minimum of the value and the bound.
  *
- * @param {number} value - The number to clamp.
- * @param {number} maximum - The maximum bound to clamp the number.
- * @returns {number} The clamped number within the specified upper bound.
+ * @param value - The number to clamp.
+ * @param maximum - The maximum bound to clamp the number.
+ * @returns The clamped number within the specified upper bound.
  *
  * @example
  * const result1 = clamp(10, 5); // result1 will be 5, as 10 is clamped to the bound 5
@@ -18,10 +18,10 @@ declare function clamp(value: number, maximum: number): number;
  *
  * This function takes a number and two bounds, and returns the number clamped within the specified bounds.
  *
- * @param {number} value - The number to clamp.
- * @param {number} minimum - The minimum bound to clamp the number.
- * @param {number} maximum - The maximum bound to clamp the number.
- * @returns {number} The clamped number within the specified bounds.
+ * @param value - The number to clamp.
+ * @param minimum - The minimum bound to clamp the number.
+ * @param maximum - The maximum bound to clamp the number.
+ * @returns The clamped number within the specified bounds.
  *
  * @example
  * const result2 = clamp(10, 5, 15); // result2 will be 10, as it is within the bounds 5 and 15

package/dist/math/clamp.js

@@ -5,10 +5,10 @@
 * This function takes a number and one or two bounds, and returns the number clamped within the specified bounds.
 * If only one bound is provided, it returns the minimum of the value and the bound.
 *
-* @param {number} value - The number to clamp.
-* @param {number} bound1 - The minimum bound to clamp the number, or the maximum bound if bound2 is not provided.
-* @param {number} [bound2] - The maximum bound to clamp the number. If not provided, the function will only consider bound1 as the upper limit.
-* @returns {number} The clamped number within the specified bounds.
+* @param value - The number to clamp.
+* @param bound1 - The minimum bound to clamp the number, or the maximum bound if bound2 is not provided.
+* @param [bound2] - The maximum bound to clamp the number. If not provided, the function will only consider bound1 as the upper limit.
+* @returns The clamped number within the specified bounds.
 *
 * @example
 * const result1 = clamp(10, 5); // result1 will be 5, as 10 is clamped to the bound 5

package/dist/math/clamp.mjs

@@ -5,10 +5,10 @@
 * This function takes a number and one or two bounds, and returns the number clamped within the specified bounds.
 * If only one bound is provided, it returns the minimum of the value and the bound.
 *
-* @param {number} value - The number to clamp.
-* @param {number} bound1 - The minimum bound to clamp the number, or the maximum bound if bound2 is not provided.
-* @param {number} [bound2] - The maximum bound to clamp the number. If not provided, the function will only consider bound1 as the upper limit.
-* @returns {number} The clamped number within the specified bounds.
+* @param value - The number to clamp.
+* @param bound1 - The minimum bound to clamp the number, or the maximum bound if bound2 is not provided.
+* @param [bound2] - The maximum bound to clamp the number. If not provided, the function will only consider bound1 as the upper limit.
+* @returns The clamped number within the specified bounds.
 *
 * @example
 * const result1 = clamp(10, 5); // result1 will be 5, as 10 is clamped to the bound 5

package/dist/math/inRange.d.mts

@@ -2,9 +2,9 @@
 /**
  * Checks if the value is less than the maximum.
  *
- * @param {number} value The value to check.
- * @param {number} maximum The upper bound of the range (exclusive).
- * @returns {boolean} `true` if the value is less than the maximum, otherwise `false`.
+ * @param value The value to check.
+ * @param maximum The upper bound of the range (exclusive).
+ * @returns `true` if the value is less than the maximum, otherwise `false`.
  *
  * @example
  * const result = inRange(3, 5); // result will be true.
@@ -14,10 +14,10 @@ declare function inRange(value: number, maximum: number): boolean;
 /**
  * Checks if the value is within the range defined by minimum (inclusive) and maximum (exclusive).
  *
- * @param {number} value The value to check.
- * @param {number} minimum The lower bound of the range (inclusive).
- * @param {number} maximum The upper bound of the range (exclusive).
- * @returns {boolean} `true` if the value is within the specified range, otherwise `false`.
+ * @param value The value to check.
+ * @param minimum The lower bound of the range (inclusive).
+ * @param maximum The upper bound of the range (exclusive).
+ * @returns `true` if the value is within the specified range, otherwise `false`.
  *
  * @example
  * const result = inRange(3, 2, 5); // result will be true.

package/dist/math/inRange.d.ts

@@ -2,9 +2,9 @@
 /**
  * Checks if the value is less than the maximum.
  *
- * @param {number} value The value to check.
- * @param {number} maximum The upper bound of the range (exclusive).
- * @returns {boolean} `true` if the value is less than the maximum, otherwise `false`.
+ * @param value The value to check.
+ * @param maximum The upper bound of the range (exclusive).
+ * @returns `true` if the value is less than the maximum, otherwise `false`.
  *
  * @example
  * const result = inRange(3, 5); // result will be true.
@@ -14,10 +14,10 @@ declare function inRange(value: number, maximum: number): boolean;
 /**
  * Checks if the value is within the range defined by minimum (inclusive) and maximum (exclusive).
  *
- * @param {number} value The value to check.
- * @param {number} minimum The lower bound of the range (inclusive).
- * @param {number} maximum The upper bound of the range (exclusive).
- * @returns {boolean} `true` if the value is within the specified range, otherwise `false`.
+ * @param value The value to check.
+ * @param minimum The lower bound of the range (inclusive).
+ * @param maximum The upper bound of the range (exclusive).
+ * @returns `true` if the value is within the specified range, otherwise `false`.
  *
  * @example
  * const result = inRange(3, 2, 5); // result will be true.

package/dist/math/inRange.js

@@ -2,10 +2,10 @@
 /**
 * Checks if the value is within a specified range.
 *
-* @param {number} value The value to check.
-* @param {number} minimum The lower bound of the range (inclusive).
-* @param {number} maximum The upper bound of the range (exclusive).
-* @returns {boolean} `true` if the value is within the specified range, otherwise `false`.
+* @param value The value to check.
+* @param minimum The lower bound of the range (inclusive).
+* @param maximum The upper bound of the range (exclusive).
+* @returns `true` if the value is within the specified range, otherwise `false`.
 * @throws {Error} Throws an error if the `minimum` is greater or equal than the `maximum`.
 *
 * @example

package/dist/math/inRange.mjs

@@ -2,10 +2,10 @@
 /**
 * Checks if the value is within a specified range.
 *
-* @param {number} value The value to check.
-* @param {number} minimum The lower bound of the range (inclusive).
-* @param {number} maximum The upper bound of the range (exclusive).
-* @returns {boolean} `true` if the value is within the specified range, otherwise `false`.
+* @param value The value to check.
+* @param minimum The lower bound of the range (inclusive).
+* @param maximum The upper bound of the range (exclusive).
+* @returns `true` if the value is within the specified range, otherwise `false`.
 * @throws {Error} Throws an error if the `minimum` is greater or equal than the `maximum`.
 *
 * @example

package/dist/math/mean.d.mts

@@ -4,8 +4,8 @@
  *
  * If the array is empty, this function returns `NaN`.
  *
- * @param {number[]} nums - An array of numbers to calculate the average.
- * @returns {number} The average of all the numbers in the array.
+ * @param nums - An array of numbers to calculate the average.
+ * @returns The average of all the numbers in the array.
  *
  * @example
  * const numbers = [1, 2, 3, 4, 5];

package/dist/math/mean.d.ts

@@ -4,8 +4,8 @@
  *
  * If the array is empty, this function returns `NaN`.
  *
- * @param {number[]} nums - An array of numbers to calculate the average.
- * @returns {number} The average of all the numbers in the array.
+ * @param nums - An array of numbers to calculate the average.
+ * @returns The average of all the numbers in the array.
  *
  * @example
  * const numbers = [1, 2, 3, 4, 5];

package/dist/math/mean.js

@@ -5,8 +5,8 @@ const require_sum = require("./sum.js");
 *
 * If the array is empty, this function returns `NaN`.
 *
-* @param {number[]} nums - An array of numbers to calculate the average.
-* @returns {number} The average of all the numbers in the array.
+* @param nums - An array of numbers to calculate the average.
+* @returns The average of all the numbers in the array.
 *
 * @example
 * const numbers = [1, 2, 3, 4, 5];

package/dist/math/mean.mjs

@@ -5,8 +5,8 @@ import { sum } from "./sum.mjs";
 *
 * If the array is empty, this function returns `NaN`.
 *
-* @param {number[]} nums - An array of numbers to calculate the average.
-* @returns {number} The average of all the numbers in the array.
+* @param nums - An array of numbers to calculate the average.
+* @returns The average of all the numbers in the array.
 *
 * @example
 * const numbers = [1, 2, 3, 4, 5];

package/dist/math/meanBy.d.mts

@@ -6,9 +6,9 @@
  * If the array is empty, this function returns `NaN`.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} items An array to calculate the average.
- * @param {(element: T) => number} getValue A function that selects a numeric value from each element.
- * @returns {number} The average of all the numbers as determined by the `getValue` function.
+ * @param items An array to calculate the average.
+ * @param getValue A function that selects a numeric value from each element.
+ * @returns The average of all the numbers as determined by the `getValue` function.
  *
  * @example
  * meanBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: 2

package/dist/math/meanBy.d.ts

@@ -6,9 +6,9 @@
  * If the array is empty, this function returns `NaN`.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} items An array to calculate the average.
- * @param {(element: T) => number} getValue A function that selects a numeric value from each element.
- * @returns {number} The average of all the numbers as determined by the `getValue` function.
+ * @param items An array to calculate the average.
+ * @param getValue A function that selects a numeric value from each element.
+ * @returns The average of all the numbers as determined by the `getValue` function.
  *
  * @example
  * meanBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: 2

package/dist/math/meanBy.js

@@ -7,9 +7,9 @@ const require_sumBy = require("./sumBy.js");
 * If the array is empty, this function returns `NaN`.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} items An array to calculate the average.
-* @param {(element: T) => number} getValue A function that selects a numeric value from each element.
-* @returns {number} The average of all the numbers as determined by the `getValue` function.
+* @param items An array to calculate the average.
+* @param getValue A function that selects a numeric value from each element.
+* @returns The average of all the numbers as determined by the `getValue` function.
 *
 * @example
 * meanBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: 2

package/dist/math/meanBy.mjs

@@ -7,9 +7,9 @@ import { sumBy } from "./sumBy.mjs";
 * If the array is empty, this function returns `NaN`.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} items An array to calculate the average.
-* @param {(element: T) => number} getValue A function that selects a numeric value from each element.
-* @returns {number} The average of all the numbers as determined by the `getValue` function.
+* @param items An array to calculate the average.
+* @param getValue A function that selects a numeric value from each element.
+* @returns The average of all the numbers as determined by the `getValue` function.
 *
 * @example
 * meanBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: 2

package/dist/math/median.d.mts

@@ -8,8 +8,8 @@
  *
  * If the array is empty, this function returns `NaN`.
  *
- * @param {number[]} nums - An array of numbers to calculate the median.
- * @returns {number} The median of all the numbers in the array.
+ * @param nums - An array of numbers to calculate the median.
+ * @returns The median of all the numbers in the array.
  *
  * @example
  * const arrayWithOddNumberOfElements = [1, 2, 3, 4, 5];

package/dist/math/median.d.ts

@@ -8,8 +8,8 @@
  *
  * If the array is empty, this function returns `NaN`.
  *
- * @param {number[]} nums - An array of numbers to calculate the median.
- * @returns {number} The median of all the numbers in the array.
+ * @param nums - An array of numbers to calculate the median.
+ * @returns The median of all the numbers in the array.
  *
  * @example
  * const arrayWithOddNumberOfElements = [1, 2, 3, 4, 5];

package/dist/math/median.js

@@ -8,8 +8,8 @@
 *
 * If the array is empty, this function returns `NaN`.
 *
-* @param {number[]} nums - An array of numbers to calculate the median.
-* @returns {number} The median of all the numbers in the array.
+* @param nums - An array of numbers to calculate the median.
+* @returns The median of all the numbers in the array.
 *
 * @example
 * const arrayWithOddNumberOfElements = [1, 2, 3, 4, 5];