es-toolkit 1.16.0-dev.455 → 1.16.0-dev.456

package/dist/compat/_internal/getPath.mjs

@@ -4,23 +4,27 @@ import { toPath } from './toPath.mjs';
 function getPath(key, object) {
     if (Array.isArray(key)) {
         const path = [];
+        let target = object;
         for (let i = 0; i < key.length; i++) {
             const k = key[i];
-            if (isKey(k, object)) {
-                object = object[k];
+            if (isKey(k, target)) {
+                target = target[k];
                 path.push(k);
             }
             else {
                 const keys = toPath(k);
                 for (let i = 0; i < keys.length; i++) {
-                    object = object[keys[i]];
+                    target = target[keys[i]];
                     path.push(keys[i]);
                 }
             }
         }
         return path;
     }
-    return isKey(key, object) ? key : toPath(key);
+    if (typeof key === 'function' || isKey(key, object)) {
+        return key;
+    }
+    return toPath(key);
 }
 
 export { getPath };

package/dist/compat/array/orderBy.d.mts

@@ -8,7 +8,7 @@
  *
  * @template T - The type of elements in the array.
  * @param {T[] | null} collection - The array of objects to be sorted.
- * @param {string | Array<string | string[]>} keys - An array of keys (property names or property paths) to sort by.
+ * @param {((item: T) => unknown) | string | Array<((item: T) => unknown) | string | string[]>} keys - An array of keys (property names or property paths or custom key functions) to sort by.
  * @param {unknown | unknown[]} orders - An array of order directions ('asc' for ascending or 'desc' for descending).
  * @returns {T[]} - The sorted array.
  *
@@ -20,7 +20,7 @@
  *   { user: 'fred', age: 40 },
  *   { user: 'barney', age: 36 },
  * ];
- * const result = orderBy(users, ['user', 'age'], ['asc', 'desc']);
+ * const result = orderBy(users, ['user', (item) => item.age], ['asc', 'desc']);
  * // result will be:
  * // [
  * //   { user: 'barney', age: 36 },
@@ -29,6 +29,6 @@
  * //   { user: 'fred', age: 40 },
  * // ]
  */
-declare function orderBy<T extends object>(collection?: T[] | null, keys?: string | Array<string | string[]>, orders?: unknown | unknown[]): T[];
+declare function orderBy<T extends object>(collection: T[] | null | undefined, keys?: ((item: T) => unknown) | string | Array<((item: T) => unknown) | string | string[]>, orders?: unknown | unknown[]): T[];
 
 export { orderBy };

package/dist/compat/array/orderBy.d.ts

@@ -8,7 +8,7 @@
  *
  * @template T - The type of elements in the array.
  * @param {T[] | null} collection - The array of objects to be sorted.
- * @param {string | Array<string | string[]>} keys - An array of keys (property names or property paths) to sort by.
+ * @param {((item: T) => unknown) | string | Array<((item: T) => unknown) | string | string[]>} keys - An array of keys (property names or property paths or custom key functions) to sort by.
  * @param {unknown | unknown[]} orders - An array of order directions ('asc' for ascending or 'desc' for descending).
  * @returns {T[]} - The sorted array.
  *
@@ -20,7 +20,7 @@
  *   { user: 'fred', age: 40 },
  *   { user: 'barney', age: 36 },
  * ];
- * const result = orderBy(users, ['user', 'age'], ['asc', 'desc']);
+ * const result = orderBy(users, ['user', (item) => item.age], ['asc', 'desc']);
  * // result will be:
  * // [
  * //   { user: 'barney', age: 36 },
@@ -29,6 +29,6 @@
  * //   { user: 'fred', age: 40 },
  * // ]
  */
-declare function orderBy<T extends object>(collection?: T[] | null, keys?: string | Array<string | string[]>, orders?: unknown | unknown[]): T[];
+declare function orderBy<T extends object>(collection: T[] | null | undefined, keys?: ((item: T) => unknown) | string | Array<((item: T) => unknown) | string | string[]>, orders?: unknown | unknown[]): T[];
 
 export { orderBy };

package/dist/compat/array/orderBy.mjs

@@ -19,23 +19,25 @@ function orderBy(collection, keys, orders) {
         }
         return 0;
     };
-    const getValueByPath = (key, obj) => {
-        if (Array.isArray(key)) {
+    const getValueByPath = (path, obj) => {
+        if (Array.isArray(path)) {
             let value = obj;
-            for (let i = 0; i < key.length; i++) {
-                value = value[key[i]];
+            for (let i = 0; i < path.length; i++) {
+                value = value[path[i]];
             }
             return value;
         }
-        return obj[key];
+        if (typeof path === 'function') {
+            return path(obj);
+        }
+        return obj[path];
     };
     keys = keys.map(key => getPath(key, collection[0]));
-    const shallowCopiedCollection = collection.slice();
-    const orderedCollection = shallowCopiedCollection.sort((a, b) => {
+    return collection.slice().sort((a, b) => {
         for (let i = 0; i < keys.length; i++) {
-            const key = keys[i];
-            const valueA = getValueByPath(key, a);
-            const valueB = getValueByPath(key, b);
+            const path = keys[i];
+            const valueA = getValueByPath(path, a);
+            const valueB = getValueByPath(path, b);
             const order = String(orders[i]);
             const comparedResult = compareValues(valueA, valueB, order);
             if (comparedResult !== 0) {
@@ -44,7 +46,6 @@ function orderBy(collection, keys, orders) {
         }
         return 0;
     });
-    return orderedCollection;
 }
 
 export { orderBy };

package/dist/compat/index.js

@@ -442,23 +442,27 @@ function isKey(value, object) {
 function getPath(key, object) {
     if (Array.isArray(key)) {
         const path = [];
+        let target = object;
         for (let i = 0; i < key.length; i++) {
             const k = key[i];
-            if (isKey(k, object)) {
-                object = object[k];
+            if (isKey(k, target)) {
+                target = target[k];
                 path.push(k);
             }
             else {
                 const keys = toPath(k);
                 for (let i = 0; i < keys.length; i++) {
-                    object = object[keys[i]];
+                    target = target[keys[i]];
                     path.push(keys[i]);
                 }
             }
         }
         return path;
     }
-    return isKey(key, object) ? key : toPath(key);
+    if (typeof key === 'function' || isKey(key, object)) {
+        return key;
+    }
+    return toPath(key);
 }
 
 function orderBy(collection, keys, orders) {
@@ -480,23 +484,25 @@ function orderBy(collection, keys, orders) {
         }
         return 0;
     };
-    const getValueByPath = (key, obj) => {
-        if (Array.isArray(key)) {
+    const getValueByPath = (path, obj) => {
+        if (Array.isArray(path)) {
             let value = obj;
-            for (let i = 0; i < key.length; i++) {
-                value = value[key[i]];
+            for (let i = 0; i < path.length; i++) {
+                value = value[path[i]];
             }
             return value;
         }
-        return obj[key];
+        if (typeof path === 'function') {
+            return path(obj);
+        }
+        return obj[path];
     };
     keys = keys.map(key => getPath(key, collection[0]));
-    const shallowCopiedCollection = collection.slice();
-    const orderedCollection = shallowCopiedCollection.sort((a, b) => {
+    return collection.slice().sort((a, b) => {
         for (let i = 0; i < keys.length; i++) {
-            const key = keys[i];
-            const valueA = getValueByPath(key, a);
-            const valueB = getValueByPath(key, b);
+            const path = keys[i];
+            const valueA = getValueByPath(path, a);
+            const valueB = getValueByPath(path, b);
             const order = String(orders[i]);
             const comparedResult = compareValues(valueA, valueB, order);
             if (comparedResult !== 0) {
@@ -505,7 +511,6 @@ function orderBy(collection, keys, orders) {
         }
         return 0;
     });
-    return orderedCollection;
 }
 
 function size(target) {

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.16.0-dev.455+f08fbd1b",
+  "version": "1.16.0-dev.456+4637a17b",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {