es-toolkit 1.29.0 → 1.30.0

package/dist/compat/index.mjs

@@ -1,6 +1,5 @@
 export { at } from '../array/at.mjs';
 export { countBy } from '../array/countBy.mjs';
-export { differenceWith } from '../array/differenceWith.mjs';
 export { flatMap } from '../array/flatMap.mjs';
 export { flatMapDeep } from '../array/flatMapDeep.mjs';
 export { forEachRight } from '../array/forEachRight.mjs';
@@ -16,7 +15,6 @@ export { partition } from '../array/partition.mjs';
 export { pullAt } from '../array/pullAt.mjs';
 export { sampleSize } from '../array/sampleSize.mjs';
 export { shuffle } from '../array/shuffle.mjs';
-export { takeRightWhile } from '../array/takeRightWhile.mjs';
 export { takeWhile } from '../array/takeWhile.mjs';
 export { toFilled } from '../array/toFilled.mjs';
 export { unionBy } from '../array/unionBy.mjs';
@@ -30,7 +28,6 @@ export { zipObject } from '../array/zipObject.mjs';
 export { zipWith } from '../array/zipWith.mjs';
 export { AbortError } from '../error/AbortError.mjs';
 export { TimeoutError } from '../error/TimeoutError.mjs';
-export { after } from '../function/after.mjs';
 export { identity } from '../function/identity.mjs';
 export { memoize } from '../function/memoize.mjs';
 export { negate } from '../function/negate.mjs';
@@ -44,11 +41,8 @@ export { meanBy } from '../math/meanBy.mjs';
 export { median } from '../math/median.mjs';
 export { medianBy } from '../math/medianBy.mjs';
 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 { 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';
@@ -66,17 +60,12 @@ export { isLength } from '../predicate/isLength.mjs';
 export { isNotNil } from '../predicate/isNotNil.mjs';
 export { isNull } from '../predicate/isNull.mjs';
 export { isUndefined } from '../predicate/isUndefined.mjs';
-export { delay } from '../promise/delay.mjs';
 export { timeout } from '../promise/timeout.mjs';
 export { withTimeout } from '../promise/withTimeout.mjs';
 export { capitalize } from '../string/capitalize.mjs';
 export { constantCase } from '../string/constantCase.mjs';
-export { deburr } from '../string/deburr.mjs';
-export { escapeRegExp } from '../string/escapeRegExp.mjs';
-export { lowerFirst } from '../string/lowerFirst.mjs';
+import '../string/deburr.mjs';
 export { pascalCase } from '../string/pascalCase.mjs';
-export { unescape } from '../string/unescape.mjs';
-export { upperFirst } from '../string/upperFirst.mjs';
 export { invariant } from '../util/invariant.mjs';
 export { castArray } from './array/castArray.mjs';
 export { chunk } from './array/chunk.mjs';
@@ -84,6 +73,7 @@ export { compact } from './array/compact.mjs';
 export { concat } from './array/concat.mjs';
 export { difference } from './array/difference.mjs';
 export { differenceBy } from './array/differenceBy.mjs';
+export { differenceWith } from './array/differenceWith.mjs';
 export { drop } from './array/drop.mjs';
 export { dropRight } from './array/dropRight.mjs';
 export { dropRightWhile } from './array/dropRightWhile.mjs';
@@ -106,7 +96,10 @@ export { intersectionBy } from './array/intersectionBy.mjs';
 export { join } from './array/join.mjs';
 export { last } from './array/last.mjs';
 export { lastIndexOf } from './array/lastIndexOf.mjs';
+export { map } from './array/map.mjs';
+export { nth } from './array/nth.mjs';
 export { orderBy } from './array/orderBy.mjs';
+export { pull } from './array/pull.mjs';
 export { sample } from './array/sample.mjs';
 export { size } from './array/size.mjs';
 export { slice } from './array/slice.mjs';
@@ -115,6 +108,7 @@ export { sortBy } from './array/sortBy.mjs';
 export { tail } from './array/tail.mjs';
 export { take } from './array/take.mjs';
 export { takeRight } from './array/takeRight.mjs';
+export { takeRightWhile } from './array/takeRightWhile.mjs';
 export { union } from './array/union.mjs';
 export { uniq } from './array/uniq.mjs';
 export { uniqBy } from './array/uniqBy.mjs';
@@ -122,6 +116,7 @@ export { unzip } from './array/unzip.mjs';
 export { without } from './array/without.mjs';
 export { zip } from './array/zip.mjs';
 export { zipObjectDeep } from './array/zipObjectDeep.mjs';
+export { after } from './function/after.mjs';
 export { ary } from './function/ary.mjs';
 export { attempt } from './function/attempt.mjs';
 export { before } from './function/before.mjs';
@@ -131,9 +126,11 @@ export { curry } from './function/curry.mjs';
 export { curryRight } from './function/curryRight.mjs';
 export { debounce } from './function/debounce.mjs';
 export { defer } from './function/defer.mjs';
+export { delay } from './function/delay.mjs';
 export { flip } from './function/flip.mjs';
 export { flow } from './function/flow.mjs';
 export { flowRight } from './function/flowRight.mjs';
+export { nthArg } from './function/nthArg.mjs';
 export { rearg } from './function/rearg.mjs';
 export { rest } from './function/rest.mjs';
 export { spread } from './function/spread.mjs';
@@ -147,6 +144,8 @@ export { max } from './math/max.mjs';
 export { min } from './math/min.mjs';
 export { parseInt } from './math/parseInt.mjs';
 export { random } from './math/random.mjs';
+export { range } from './math/range.mjs';
+export { rangeRight } from './math/rangeRight.mjs';
 export { round } from './math/round.mjs';
 export { sum } from './math/sum.mjs';
 export { sumBy } from './math/sumBy.mjs';
@@ -154,10 +153,12 @@ 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';
 export { invertBy } from './object/invertBy.mjs';
+export { keys } from './object/keys.mjs';
 export { keysIn } from './object/keysIn.mjs';
 export { mapKeys } from './object/mapKeys.mjs';
 export { mapValues } from './object/mapValues.mjs';
@@ -166,6 +167,7 @@ export { mergeWith } from './object/mergeWith.mjs';
 export { omit } from './object/omit.mjs';
 export { pick } from './object/pick.mjs';
 export { property } from './object/property.mjs';
+export { propertyOf } from './object/propertyOf.mjs';
 export { set } from './object/set.mjs';
 export { toDefaulted } from './object/toDefaulted.mjs';
 export { unset } from './object/unset.mjs';
@@ -202,10 +204,13 @@ export { isWeakSet } from './predicate/isWeakSet.mjs';
 export { matches } from './predicate/matches.mjs';
 export { matchesProperty } from './predicate/matchesProperty.mjs';
 export { camelCase } from './string/camelCase.mjs';
+export { deburr } from './string/deburr.mjs';
 export { endsWith } from './string/endsWith.mjs';
 export { escape } from './string/escape.mjs';
+export { escapeRegExp } from './string/escapeRegExp.mjs';
 export { kebabCase } from './string/kebabCase.mjs';
 export { lowerCase } from './string/lowerCase.mjs';
+export { lowerFirst } from './string/lowerFirst.mjs';
 export { pad } from './string/pad.mjs';
 export { padEnd } from './string/padEnd.mjs';
 export { padStart } from './string/padStart.mjs';
@@ -215,17 +220,30 @@ export { snakeCase } from './string/snakeCase.mjs';
 export { startCase } from './string/startCase.mjs';
 export { startsWith } from './string/startsWith.mjs';
 export { template, templateSettings } from './string/template.mjs';
+export { toLower } from './string/toLower.mjs';
 export { toUpper } from './string/toUpper.mjs';
 export { trim } from './string/trim.mjs';
 export { trimEnd } from './string/trimEnd.mjs';
 export { trimStart } from './string/trimStart.mjs';
+export { unescape } from './string/unescape.mjs';
 export { upperCase } from './string/upperCase.mjs';
+export { upperFirst } from './string/upperFirst.mjs';
 export { words } from './string/words.mjs';
 export { constant } from './util/constant.mjs';
 export { defaultTo } from './util/defaultTo.mjs';
 export { gt } from './util/gt.mjs';
 export { gte } from './util/gte.mjs';
+export { invoke } from './util/invoke.mjs';
 export { iteratee } from './util/iteratee.mjs';
+export { lt } from './util/lt.mjs';
+export { lte } from './util/lte.mjs';
+export { method } from './util/method.mjs';
+export { now } from './util/now.mjs';
+export { stubArray } from './util/stubArray.mjs';
+export { stubFalse } from './util/stubFalse.mjs';
+export { stubObject } from './util/stubObject.mjs';
+export { stubString } from './util/stubString.mjs';
+export { stubTrue } from './util/stubTrue.mjs';
 export { times } from './util/times.mjs';
 export { toArray } from './util/toArray.mjs';
 export { toFinite } from './util/toFinite.mjs';
@@ -233,6 +251,6 @@ export { toInteger } from './util/toInteger.mjs';
 export { toLength } from './util/toLength.mjs';
 export { toNumber } from './util/toNumber.mjs';
 export { toPath } from './util/toPath.mjs';
+export { toPlainObject } from './util/toPlainObject.mjs';
 export { toSafeInteger } from './util/toSafeInteger.mjs';
 export { toString } from './util/toString.mjs';
-export { uniqueId } from './util/uniqueId.mjs';

package/dist/compat/math/range.d.mts

@@ -0,0 +1,47 @@
+/**
+ * Returns an array of numbers from `0` (inclusive) to `end` (exclusive), incrementing by `1`.
+ *
+ * @param {number} end - The end number of the range (exclusive).
+ * @returns {number[]} An array of numbers from `0` (inclusive) to `end` (exclusive) with a step of `1`.
+ *
+ * @example
+ * // Returns [0, 1, 2, 3]
+ * range(4);
+ */
+declare function range(end: number): number[];
+/**
+ * Returns an array of numbers from `start` (inclusive) to `end` (exclusive), incrementing by `1`.
+ *
+ * @param {number} start - The starting number of the range (inclusive).
+ * @param {number} end - The end number of the range (exclusive).
+ * @returns {number[]} An array of numbers from `start` (inclusive) to `end` (exclusive) with a step of `1`.
+ *
+ * @example
+ * // Returns [1, 2, 3]
+ * range(1, 4);
+ */
+declare function range(start: number, end: number): number[];
+/**
+ * Returns an array of numbers from `start` (inclusive) to `end` (exclusive), incrementing by `step`.
+ *
+ * @param {number} start - The starting number of the range (inclusive).
+ * @param {number} end - The end number of the range (exclusive).
+ * @param {number} step - The step value for the range.
+ * @returns {number[]} An array of numbers from `start` (inclusive) to `end` (exclusive) with the specified `step`.
+ *
+ * @example
+ * // Returns [0, 5, 10, 15]
+ * range(0, 20, 5);
+ */
+declare function range(start: number, end: number, step: number): number[];
+/**
+ * Enables use as an iteratee for methods like `_.map`.
+ *
+ * @param {number} end - The current iteratee value.
+ * @param {PropertyKey} index - The iteration index.
+ * @param {object} guard - The iteratee object.
+ * @returns {number[]} An array of numbers from `start` (inclusive) to `end` (exclusive) with the specified `step`.
+ */
+declare function range(end: number, index: PropertyKey, guard: object): number[];
+
+export { range };

package/dist/compat/math/range.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Returns an array of numbers from `0` (inclusive) to `end` (exclusive), incrementing by `1`.
+ *
+ * @param {number} end - The end number of the range (exclusive).
+ * @returns {number[]} An array of numbers from `0` (inclusive) to `end` (exclusive) with a step of `1`.
+ *
+ * @example
+ * // Returns [0, 1, 2, 3]
+ * range(4);
+ */
+declare function range(end: number): number[];
+/**
+ * Returns an array of numbers from `start` (inclusive) to `end` (exclusive), incrementing by `1`.
+ *
+ * @param {number} start - The starting number of the range (inclusive).
+ * @param {number} end - The end number of the range (exclusive).
+ * @returns {number[]} An array of numbers from `start` (inclusive) to `end` (exclusive) with a step of `1`.
+ *
+ * @example
+ * // Returns [1, 2, 3]
+ * range(1, 4);
+ */
+declare function range(start: number, end: number): number[];
+/**
+ * Returns an array of numbers from `start` (inclusive) to `end` (exclusive), incrementing by `step`.
+ *
+ * @param {number} start - The starting number of the range (inclusive).
+ * @param {number} end - The end number of the range (exclusive).
+ * @param {number} step - The step value for the range.
+ * @returns {number[]} An array of numbers from `start` (inclusive) to `end` (exclusive) with the specified `step`.
+ *
+ * @example
+ * // Returns [0, 5, 10, 15]
+ * range(0, 20, 5);
+ */
+declare function range(start: number, end: number, step: number): number[];
+/**
+ * Enables use as an iteratee for methods like `_.map`.
+ *
+ * @param {number} end - The current iteratee value.
+ * @param {PropertyKey} index - The iteration index.
+ * @param {object} guard - The iteratee object.
+ * @returns {number[]} An array of numbers from `start` (inclusive) to `end` (exclusive) with the specified `step`.
+ */
+declare function range(end: number, index: PropertyKey, guard: object): number[];
+
+export { range };

package/dist/compat/math/range.mjs

@@ -0,0 +1,26 @@
+import { isIterateeCall } from '../_internal/isIterateeCall.mjs';
+import { toFinite } from '../util/toFinite.mjs';
+
+function range(start, end, step) {
+    if (step && typeof step !== 'number' && isIterateeCall(start, end, step)) {
+        end = step = undefined;
+    }
+    start = toFinite(start);
+    if (end === undefined) {
+        end = start;
+        start = 0;
+    }
+    else {
+        end = toFinite(end);
+    }
+    step = step === undefined ? (start < end ? 1 : -1) : toFinite(step);
+    const length = Math.max(Math.ceil((end - start) / (step || 1)), 0);
+    const result = new Array(length);
+    for (let index = 0; index < length; index++) {
+        result[index] = start;
+        start += step;
+    }
+    return result;
+}
+
+export { range };

package/dist/compat/math/rangeRight.d.mts

@@ -0,0 +1,47 @@
+/**
+ * Returns an array of numbers from `end` (exclusive) to `0` (inclusive), decrementing by `1`.
+ *
+ * @param {number} end - The end number of the range (exclusive).
+ * @returns {number[]} An array of numbers from `end` (exclusive) to `0` (inclusive) with a step of `1`.
+ *
+ * @example
+ * // Returns [3, 2, 1, 0]
+ * rangeRight(4);
+ */
+declare function rangeRight(end: number): number[];
+/**
+ * Returns an array of numbers from `end` (exclusive) to `start` (inclusive), decrementing by `1`.
+ *
+ * @param {number} start - The starting number of the range (inclusive).
+ * @param {number} end - The end number of the range (exclusive).
+ * @returns {number[]} An array of numbers from `end` (exclusive) to `start` (inclusive) with a step of `1`.
+ *
+ * @example
+ * // Returns [3, 2, 1]
+ * rangeRight(1, 4);
+ */
+declare function rangeRight(start: number, end: number): number[];
+/**
+ * Returns an array of numbers from `end` (exclusive) to `start` (inclusive), decrementing by `step`.
+ *
+ * @param {number} start - The starting number of the range (inclusive).
+ * @param {number} end - The end number of the range (exclusive).
+ * @param {number} step - The step value for the range.
+ * @returns {number[]} An array of numbers from `end` (exclusive) to `start` (inclusive) with the specified `step`.
+ *
+ * @example
+ * // Returns [15, 10, 5, 0]
+ * rangeRight(0, 20, 5);
+ */
+declare function rangeRight(start: number, end: number, step: number): number[];
+/**
+ * Enables use as an iteratee for methods like `_.map`.
+ *
+ * @param {number} end - The current iteratee value.
+ * @param {PropertyKey} index - The iteration index.
+ * @param {object} guard - The iteratee object.
+ * @returns {number[]} An array of numbers from `start` (inclusive) to `end` (exclusive) with the specified `step`.
+ */
+declare function rangeRight(end: number, index: PropertyKey, guard: object): number[];
+
+export { rangeRight };

package/dist/compat/math/rangeRight.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Returns an array of numbers from `end` (exclusive) to `0` (inclusive), decrementing by `1`.
+ *
+ * @param {number} end - The end number of the range (exclusive).
+ * @returns {number[]} An array of numbers from `end` (exclusive) to `0` (inclusive) with a step of `1`.
+ *
+ * @example
+ * // Returns [3, 2, 1, 0]
+ * rangeRight(4);
+ */
+declare function rangeRight(end: number): number[];
+/**
+ * Returns an array of numbers from `end` (exclusive) to `start` (inclusive), decrementing by `1`.
+ *
+ * @param {number} start - The starting number of the range (inclusive).
+ * @param {number} end - The end number of the range (exclusive).
+ * @returns {number[]} An array of numbers from `end` (exclusive) to `start` (inclusive) with a step of `1`.
+ *
+ * @example
+ * // Returns [3, 2, 1]
+ * rangeRight(1, 4);
+ */
+declare function rangeRight(start: number, end: number): number[];
+/**
+ * Returns an array of numbers from `end` (exclusive) to `start` (inclusive), decrementing by `step`.
+ *
+ * @param {number} start - The starting number of the range (inclusive).
+ * @param {number} end - The end number of the range (exclusive).
+ * @param {number} step - The step value for the range.
+ * @returns {number[]} An array of numbers from `end` (exclusive) to `start` (inclusive) with the specified `step`.
+ *
+ * @example
+ * // Returns [15, 10, 5, 0]
+ * rangeRight(0, 20, 5);
+ */
+declare function rangeRight(start: number, end: number, step: number): number[];
+/**
+ * Enables use as an iteratee for methods like `_.map`.
+ *
+ * @param {number} end - The current iteratee value.
+ * @param {PropertyKey} index - The iteration index.
+ * @param {object} guard - The iteratee object.
+ * @returns {number[]} An array of numbers from `start` (inclusive) to `end` (exclusive) with the specified `step`.
+ */
+declare function rangeRight(end: number, index: PropertyKey, guard: object): number[];
+
+export { rangeRight };

package/dist/compat/math/rangeRight.mjs

@@ -0,0 +1,26 @@
+import { isIterateeCall } from '../_internal/isIterateeCall.mjs';
+import { toFinite } from '../util/toFinite.mjs';
+
+function rangeRight(start, end, step) {
+    if (step && typeof step !== 'number' && isIterateeCall(start, end, step)) {
+        end = step = undefined;
+    }
+    start = toFinite(start);
+    if (end === undefined) {
+        end = start;
+        start = 0;
+    }
+    else {
+        end = toFinite(end);
+    }
+    step = step === undefined ? (start < end ? 1 : -1) : toFinite(step);
+    const length = Math.max(Math.ceil((end - start) / (step || 1)), 0);
+    const result = new Array(length);
+    for (let index = length - 1; index >= 0; index--) {
+        result[index] = start;
+        start += step;
+    }
+    return result;
+}
+
+export { rangeRight };

package/dist/compat/math/sumBy.d.mts

@@ -34,7 +34,7 @@ declare function sumBy(array: ArrayLike<bigint>): bigint;
  */
 declare function sumBy(array: ArrayLike<unknown> | null | undefined): unknown;
 /**
- * Compmutes the sum of the `number` values that are returned by the `iteratee` function.
+ * Computes the sum of the `number` values that are returned by the `iteratee` function.
  *
  * @template T - The type of the array elements.
  * @param {ArrayLike<T>} array - The array to iterate over.
@@ -46,7 +46,7 @@ declare function sumBy(array: ArrayLike<unknown> | null | undefined): unknown;
  */
 declare function sumBy<T>(array: ArrayLike<T>, iteratee: (value: T) => number): number;
 /**
- * Compmutes the sum of the `bigint` values that are returned by the `iteratee` function.
+ * Computes the sum of the `bigint` values that are returned by the `iteratee` function.
  *
  * NOTE: If the `array` is empty, the function returns `0`.
  *

package/dist/compat/math/sumBy.d.ts

@@ -34,7 +34,7 @@ declare function sumBy(array: ArrayLike<bigint>): bigint;
  */
 declare function sumBy(array: ArrayLike<unknown> | null | undefined): unknown;
 /**
- * Compmutes the sum of the `number` values that are returned by the `iteratee` function.
+ * Computes the sum of the `number` values that are returned by the `iteratee` function.
  *
  * @template T - The type of the array elements.
  * @param {ArrayLike<T>} array - The array to iterate over.
@@ -46,7 +46,7 @@ declare function sumBy(array: ArrayLike<unknown> | null | undefined): unknown;
  */
 declare function sumBy<T>(array: ArrayLike<T>, iteratee: (value: T) => number): number;
 /**
- * Compmutes the sum of the `bigint` values that are returned by the `iteratee` function.
+ * Computes the sum of the `bigint` values that are returned by the `iteratee` function.
  *
  * NOTE: If the `array` is empty, the function returns `0`.
  *

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/dist/compat/object/keys.d.mts

@@ -0,0 +1,22 @@
+/**
+ * Creates an array of the own enumerable property names of `object`.
+ *
+ * Non-object values are coerced to objects.
+ *
+ * @param {object} object The object to query.
+ * @returns {string[]} Returns the array of property names.
+ * @example
+ * function Foo() {
+ *   this.a = 1;
+ *   this.b = 2;
+ * }
+ * Foo.prototype.c = 3;
+ * keys(new Foo); // ['a', 'b'] (iteration order is not guaranteed)
+ *
+ * keys('hi'); // ['0', '1']
+ * keys([1, 2, 3]); // ['0', '1', '2']
+ * keys({ a: 1, b: 2 }); // ['a', 'b']
+ */
+declare function keys(object?: any): string[];
+
+export { keys };

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

@@ -0,0 +1,22 @@
+/**
+ * Creates an array of the own enumerable property names of `object`.
+ *
+ * Non-object values are coerced to objects.
+ *
+ * @param {object} object The object to query.
+ * @returns {string[]} Returns the array of property names.
+ * @example
+ * function Foo() {
+ *   this.a = 1;
+ *   this.b = 2;
+ * }
+ * Foo.prototype.c = 3;
+ * keys(new Foo); // ['a', 'b'] (iteration order is not guaranteed)
+ *
+ * keys('hi'); // ['0', '1']
+ * keys([1, 2, 3]); // ['0', '1', '2']
+ * keys({ a: 1, b: 2 }); // ['a', 'b']
+ */
+declare function keys(object?: any): string[];
+
+export { keys };