es-toolkit 1.25.2 → 1.26.0-dev.828

package/dist/math/medianBy.d.mts

@@ -0,0 +1,23 @@
+/**
+ * Calculates the median of an array of elements when applying
+ * the `getValue` function to each element.
+ *
+ * The median is the middle value of a sorted array.
+ * If the array has an odd number of elements, the median is the middle value.
+ * If the array has an even number of elements, it returns the average of the two middle values.
+ *
+ * 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 median.
+ * @param {(element: T) => number} getValue A function that selects a numeric value from each element.
+ * @returns {number} The median of all the numbers as determined by the `getValue` function.
+ *
+ * @example
+ * medianBy([{ a: 1 }, { a: 2 }, { a: 3 }, { a: 4 }, { a: 5 }], x => x.a); // Returns: 3
+ * medianBy([{ a: 1 }, { a: 2 }, { a: 3 }, { a: 4 }], x => x.a); // Returns: 2.5
+ * medianBy([], x => x.a); // Returns: NaN
+ */
+declare function medianBy<T>(items: readonly T[], getValue: (element: T) => number): number;
+
+export { medianBy };

package/dist/math/medianBy.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Calculates the median of an array of elements when applying
+ * the `getValue` function to each element.
+ *
+ * The median is the middle value of a sorted array.
+ * If the array has an odd number of elements, the median is the middle value.
+ * If the array has an even number of elements, it returns the average of the two middle values.
+ *
+ * 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 median.
+ * @param {(element: T) => number} getValue A function that selects a numeric value from each element.
+ * @returns {number} The median of all the numbers as determined by the `getValue` function.
+ *
+ * @example
+ * medianBy([{ a: 1 }, { a: 2 }, { a: 3 }, { a: 4 }, { a: 5 }], x => x.a); // Returns: 3
+ * medianBy([{ a: 1 }, { a: 2 }, { a: 3 }, { a: 4 }], x => x.a); // Returns: 2.5
+ * medianBy([], x => x.a); // Returns: NaN
+ */
+declare function medianBy<T>(items: readonly T[], getValue: (element: T) => number): number;
+
+export { medianBy };

package/dist/math/medianBy.mjs

@@ -0,0 +1,8 @@
+import { median } from './median.mjs';
+
+function medianBy(items, getValue) {
+    const nums = items.map(x => getValue(x));
+    return median(nums);
+}
+
+export { medianBy };

package/dist/object/cloneDeep.mjs

@@ -37,7 +37,7 @@ function cloneDeepImpl(obj, stack = new Map()) {
     if (obj instanceof Map) {
         const result = new Map();
         stack.set(obj, result);
-        for (const [key, value] of obj.entries()) {
+        for (const [key, value] of obj) {
             result.set(key, cloneDeepImpl(value, stack));
         }
         return result;
@@ -45,7 +45,7 @@ function cloneDeepImpl(obj, stack = new Map()) {
     if (obj instanceof Set) {
         const result = new Set();
         stack.set(obj, result);
-        for (const value of obj.values()) {
+        for (const value of obj) {
             result.add(cloneDeepImpl(value, stack));
         }
         return result;

package/dist/object/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-const toMerged = require('../_chunk/toMerged-BLnW4M.js');
+const toMerged = require('../_chunk/toMerged-wNz52b.js');
 
 function mergeWith(target, source, merge) {
     const sourceKeys = Object.keys(source);

package/dist/object/merge.d.mts

@@ -38,6 +38,6 @@
  * console.log(result);
  * // Output: { a: [1, 2, 3] }
  */
-declare function merge<T, S>(target: T, source: S): T & S;
+declare function merge<T extends Record<PropertyKey, any>, S extends Record<PropertyKey, any>>(target: T, source: S): T & S;
 
 export { merge };

package/dist/object/merge.d.ts

@@ -38,6 +38,6 @@
  * console.log(result);
  * // Output: { a: [1, 2, 3] }
  */
-declare function merge<T, S>(target: T, source: S): T & S;
+declare function merge<T extends Record<PropertyKey, any>, S extends Record<PropertyKey, any>>(target: T, source: S): T & S;
 
 export { merge };

package/dist/util/index.d.mts

@@ -0,0 +1 @@
+export { invariant } from './invariant.mjs';

package/dist/util/index.d.ts

@@ -0,0 +1 @@
+export { invariant } from './invariant.js';

package/dist/util/index.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+function invariant(condition, message) {
+    if (condition) {
+        return;
+    }
+    throw new Error(message);
+}
+
+exports.invariant = invariant;

package/dist/util/index.mjs

@@ -0,0 +1 @@
+export { invariant } from './invariant.mjs';

package/dist/util/invariant.d.mts

@@ -0,0 +1,27 @@
+/**
+ * Asserts that a given condition is true. If the condition is false, an error is thrown with the provided message.
+ *
+ * @param {unknown} condition - The condition to evaluate.
+ * @param {string} [message] - The error message to throw if the condition is false.
+ * @returns {void} Returns void if the condition is true.
+ * @throws {Error} Throws an error if the condition is false.
+ *
+ * @example
+ * // This call will succeed without any errors
+ * invariant(true, 'This should not throw');
+ *
+ * // This call will fail and throw an error with the message 'This should throw'
+ * invariant(false, 'This should throw');
+ *
+ * // Example of using invariant with a condition
+ * invariant(condition, 'Expected condition is false');
+ *
+ * // Ensure that the value is neither null nor undefined
+ * invariant(value !== null && value !== undefined, 'Value should not be null or undefined');
+ *
+ * // Example of using invariant to check if a number is positive
+ * invariant(number > 0, 'Number must be positive');
+ */
+declare function invariant(condition: unknown, message: string): asserts condition;
+
+export { invariant };

package/dist/util/invariant.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Asserts that a given condition is true. If the condition is false, an error is thrown with the provided message.
+ *
+ * @param {unknown} condition - The condition to evaluate.
+ * @param {string} [message] - The error message to throw if the condition is false.
+ * @returns {void} Returns void if the condition is true.
+ * @throws {Error} Throws an error if the condition is false.
+ *
+ * @example
+ * // This call will succeed without any errors
+ * invariant(true, 'This should not throw');
+ *
+ * // This call will fail and throw an error with the message 'This should throw'
+ * invariant(false, 'This should throw');
+ *
+ * // Example of using invariant with a condition
+ * invariant(condition, 'Expected condition is false');
+ *
+ * // Ensure that the value is neither null nor undefined
+ * invariant(value !== null && value !== undefined, 'Value should not be null or undefined');
+ *
+ * // Example of using invariant to check if a number is positive
+ * invariant(number > 0, 'Number must be positive');
+ */
+declare function invariant(condition: unknown, message: string): asserts condition;
+
+export { invariant };

package/dist/util/invariant.mjs

@@ -0,0 +1,8 @@
+function invariant(condition, message) {
+    if (condition) {
+        return;
+    }
+    throw new Error(message);
+}
+
+export { invariant };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "es-toolkit",
   "description": "A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.",
-  "version": "1.25.2",
+  "version": "1.26.0-dev.828+eb01f788",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {
@@ -95,6 +95,16 @@
         "default": "./dist/string/index.js"
       }
     },
+    "./util": {
+      "import": {
+        "types": "./dist/util/index.d.mts",
+        "default": "./dist/util/index.mjs"
+      },
+      "require": {
+        "types": "./dist/util/index.d.ts",
+        "default": "./dist/util/index.js"
+      }
+    },
     "./compat": {
       "import": {
         "types": "./dist/compat/index.d.mts",
@@ -198,6 +208,16 @@
           "default": "./dist/string/index.js"
         }
       },
+      "./util": {
+        "import": {
+          "types": "./dist/util/index.d.mts",
+          "default": "./dist/util/index.mjs"
+        },
+        "require": {
+          "types": "./dist/util/index.d.ts",
+          "default": "./dist/util/index.js"
+        }
+      },
       "./compat": {
         "import": {
           "types": "./dist/compat/index.d.mts",

package/util.d.ts

@@ -0,0 +1 @@
+export * from './dist/util';