es-toolkit 1.29.0-dev.921 → 1.29.0-dev.922

package/dist/compat/index.d.mts

@@ -48,7 +48,6 @@ export { randomInt } from '../math/randomInt.mjs';
 export { range } from '../math/range.mjs';
 export { rangeRight } from '../math/rangeRight.mjs';
 export { clone } from '../object/clone.mjs';
-export { findKey } from '../object/findKey.mjs';
 export { flattenObject } from '../object/flattenObject.mjs';
 export { invert } from '../object/invert.mjs';
 export { omitBy } from '../object/omitBy.mjs';
@@ -154,6 +153,7 @@ export { assignIn, assignIn as extend } from './object/assignIn.mjs';
 export { cloneDeep } from './object/cloneDeep.mjs';
 export { cloneDeepWith } from './object/cloneDeepWith.mjs';
 export { defaults } from './object/defaults.mjs';
+export { findKey } from './object/findKey.mjs';
 export { fromPairs } from './object/fromPairs.mjs';
 export { get } from './object/get.mjs';
 export { has } from './object/has.mjs';

package/dist/compat/index.d.ts

@@ -48,7 +48,6 @@ export { randomInt } from '../math/randomInt.js';
 export { range } from '../math/range.js';
 export { rangeRight } from '../math/rangeRight.js';
 export { clone } from '../object/clone.js';
-export { findKey } from '../object/findKey.js';
 export { flattenObject } from '../object/flattenObject.js';
 export { invert } from '../object/invert.js';
 export { omitBy } from '../object/omitBy.js';
@@ -154,6 +153,7 @@ export { assignIn, assignIn as extend } from './object/assignIn.js';
 export { cloneDeep } from './object/cloneDeep.js';
 export { cloneDeepWith } from './object/cloneDeepWith.js';
 export { defaults } from './object/defaults.js';
+export { findKey } from './object/findKey.js';
 export { fromPairs } from './object/fromPairs.js';
 export { get } from './object/get.js';
 export { has } from './object/has.js';

package/dist/compat/index.js

@@ -1961,6 +1961,29 @@ function defaults(object, ...sources) {
     return object;
 }
 
+function findKey(obj, predicate) {
+    if (!isObject(obj)) {
+        return undefined;
+    }
+    return findKeyImpl(obj, predicate);
+}
+function findKeyImpl(obj, predicate) {
+    if (typeof predicate === 'function') {
+        return toMerged.findKey(obj, predicate);
+    }
+    if (typeof predicate === 'object') {
+        if (Array.isArray(predicate)) {
+            const key = predicate[0];
+            const value = predicate[1];
+            return toMerged.findKey(obj, matchesProperty(key, value));
+        }
+        return toMerged.findKey(obj, matches(predicate));
+    }
+    if (typeof predicate === 'string') {
+        return toMerged.findKey(obj, property(predicate));
+    }
+}
+
 function fromPairs(pairs) {
     if (!isArrayLike(pairs) && !(pairs instanceof Map)) {
         return {};
@@ -2765,7 +2788,6 @@ exports.range = rangeRight.range;
 exports.rangeRight = rangeRight.rangeRight;
 exports.randomInt = randomInt.randomInt;
 exports.clone = toMerged.clone;
-exports.findKey = toMerged.findKey;
 exports.flattenObject = toMerged.flattenObject;
 exports.invert = toMerged.invert;
 exports.isObjectLike = toMerged.isObjectLike;
@@ -2835,6 +2857,7 @@ exports.fill = fill;
 exports.filter = filter;
 exports.find = find;
 exports.findIndex = findIndex;
+exports.findKey = findKey;
 exports.findLastIndex = findLastIndex;
 exports.first = head;
 exports.flatten = flatten;

package/dist/compat/index.mjs

@@ -48,7 +48,6 @@ export { range } from '../math/range.mjs';
 export { rangeRight } from '../math/rangeRight.mjs';
 export { clone } from '../object/clone.mjs';
 export { isPrimitive } from '../predicate/isPrimitive.mjs';
-export { findKey } from '../object/findKey.mjs';
 export { flattenObject } from '../object/flattenObject.mjs';
 export { invert } from '../object/invert.mjs';
 export { isObjectLike } from './predicate/isObjectLike.mjs';
@@ -155,6 +154,7 @@ export { assignIn, assignIn as extend } from './object/assignIn.mjs';
 export { cloneDeep } from './object/cloneDeep.mjs';
 export { cloneDeepWith } from './object/cloneDeepWith.mjs';
 export { defaults } from './object/defaults.mjs';
+export { findKey } from './object/findKey.mjs';
 export { fromPairs } from './object/fromPairs.mjs';
 export { get } from './object/get.mjs';
 export { has } from './object/has.mjs';

package/dist/compat/object/findKey.d.mts

@@ -0,0 +1,58 @@
+/**
+ * Finds the key of the first element predicate returns truthy for.
+ *
+ * @template T - The type of the object.
+ * @param {T | null | undefined} obj - The object to inspect.
+ * @param {(value: T[keyof T], key: keyof T, obj: T) => boolean} conditionToFind - The function invoked per iteration.
+ * @returns {keyof T | undefined} Returns the key of the matched element, else `undefined`.
+ *
+ * @example
+ * const users = { 'barney': { 'age': 36 }, 'fred': { 'age': 40 } };
+ * const result = findKey(users, o => o.age < 40);
+ * // => 'barney'
+ */
+declare function findKey<T extends Record<any, any>>(obj: T | null | undefined, conditionToFind: (value: T[keyof T], key: keyof T, obj: T) => boolean): keyof T | undefined;
+/**
+ * Finds the key of the first element that matches the given object.
+ *
+ * @template T - The type of the object.
+ * @param {T | null | undefined} obj - The object to inspect.
+ * @param {Partail<T[keyof T]>} objectToFind - The object to match.
+ * @returns {keyof T | undefined} Returns the key of the matched element, else `undefined`.
+ *
+ * @example
+ * const users = { 'barney': { 'age': 36 }, 'fred': { 'age': 40 } };
+ * const result = findKey(users, { 'age': 36 });
+ * // => 'barney'
+ */
+declare function findKey<T extends Record<any, any>>(obj: T | null | undefined, objectToFind: Partial<T[keyof T]>): keyof T | undefined;
+/**
+ * Finds the key of the first element that matches the given property and value.
+ *
+ * @template T - The type of the object.
+ * @param {T | null | undefined} obj - The object to inspect.
+ * @param {[keyof T[keyof T], any]} propertyToFind - The property and value to match.
+ * @returns {keyof T | undefined} Returns the key of the matched element, else `undefined`.
+ *
+ * @example
+ * const users = { 'barney': { 'age': 36 }, 'fred': { 'age': 40 } };
+ * const result = findKey(users, ['age', 36]);
+ * // => 'barney'
+ */
+declare function findKey<T extends Record<any, any>>(obj: T | null | undefined, propertyToFind: [keyof T[keyof T], any]): keyof T | undefined;
+/**
+ * Finds the key of the first element that has a truthy value for the given property.
+ *
+ * @template T - The type of the object.
+ * @param {T | null | undefined} obj - The object to inspect.
+ * @param {keyof T[keyof T]} propertyToFind - The property to check.
+ * @returns {keyof T | undefined} Returns the key of the matched element, else `undefined`.
+ *
+ * @example
+ * const users = { 'barney': { 'active': true }, 'fred': { 'active': false } };
+ * const result = findKey(users, 'active');
+ * // => 'barney'
+ */
+declare function findKey<T extends Record<any, any>>(obj: T | null | undefined, propertyToFind: keyof T[keyof T]): keyof T | undefined;
+
+export { findKey };

package/dist/compat/object/findKey.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Finds the key of the first element predicate returns truthy for.
+ *
+ * @template T - The type of the object.
+ * @param {T | null | undefined} obj - The object to inspect.
+ * @param {(value: T[keyof T], key: keyof T, obj: T) => boolean} conditionToFind - The function invoked per iteration.
+ * @returns {keyof T | undefined} Returns the key of the matched element, else `undefined`.
+ *
+ * @example
+ * const users = { 'barney': { 'age': 36 }, 'fred': { 'age': 40 } };
+ * const result = findKey(users, o => o.age < 40);
+ * // => 'barney'
+ */
+declare function findKey<T extends Record<any, any>>(obj: T | null | undefined, conditionToFind: (value: T[keyof T], key: keyof T, obj: T) => boolean): keyof T | undefined;
+/**
+ * Finds the key of the first element that matches the given object.
+ *
+ * @template T - The type of the object.
+ * @param {T | null | undefined} obj - The object to inspect.
+ * @param {Partail<T[keyof T]>} objectToFind - The object to match.
+ * @returns {keyof T | undefined} Returns the key of the matched element, else `undefined`.
+ *
+ * @example
+ * const users = { 'barney': { 'age': 36 }, 'fred': { 'age': 40 } };
+ * const result = findKey(users, { 'age': 36 });
+ * // => 'barney'
+ */
+declare function findKey<T extends Record<any, any>>(obj: T | null | undefined, objectToFind: Partial<T[keyof T]>): keyof T | undefined;
+/**
+ * Finds the key of the first element that matches the given property and value.
+ *
+ * @template T - The type of the object.
+ * @param {T | null | undefined} obj - The object to inspect.
+ * @param {[keyof T[keyof T], any]} propertyToFind - The property and value to match.
+ * @returns {keyof T | undefined} Returns the key of the matched element, else `undefined`.
+ *
+ * @example
+ * const users = { 'barney': { 'age': 36 }, 'fred': { 'age': 40 } };
+ * const result = findKey(users, ['age', 36]);
+ * // => 'barney'
+ */
+declare function findKey<T extends Record<any, any>>(obj: T | null | undefined, propertyToFind: [keyof T[keyof T], any]): keyof T | undefined;
+/**
+ * Finds the key of the first element that has a truthy value for the given property.
+ *
+ * @template T - The type of the object.
+ * @param {T | null | undefined} obj - The object to inspect.
+ * @param {keyof T[keyof T]} propertyToFind - The property to check.
+ * @returns {keyof T | undefined} Returns the key of the matched element, else `undefined`.
+ *
+ * @example
+ * const users = { 'barney': { 'active': true }, 'fred': { 'active': false } };
+ * const result = findKey(users, 'active');
+ * // => 'barney'
+ */
+declare function findKey<T extends Record<any, any>>(obj: T | null | undefined, propertyToFind: keyof T[keyof T]): keyof T | undefined;
+
+export { findKey };

package/dist/compat/object/findKey.mjs

@@ -0,0 +1,30 @@
+import { property } from './property.mjs';
+import { findKey as findKey$1 } from '../../object/findKey.mjs';
+import { isObject } from '../predicate/isObject.mjs';
+import { matches } from '../predicate/matches.mjs';
+import { matchesProperty } from '../predicate/matchesProperty.mjs';
+
+function findKey(obj, predicate) {
+    if (!isObject(obj)) {
+        return undefined;
+    }
+    return findKeyImpl(obj, predicate);
+}
+function findKeyImpl(obj, predicate) {
+    if (typeof predicate === 'function') {
+        return findKey$1(obj, predicate);
+    }
+    if (typeof predicate === 'object') {
+        if (Array.isArray(predicate)) {
+            const key = predicate[0];
+            const value = predicate[1];
+            return findKey$1(obj, matchesProperty(key, value));
+        }
+        return findKey$1(obj, matches(predicate));
+    }
+    if (typeof predicate === 'string') {
+        return findKey$1(obj, property(predicate));
+    }
+}
+
+export { findKey };

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.29.0-dev.921+976d5095",
+  "version": "1.29.0-dev.922+917aff01",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {