es-toolkit 1.15.1-dev.432 → 1.15.1-dev.434

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

@@ -0,0 +1,62 @@
+/**
+ * Finds the index of the first item in an array that matches the given predicate function.
+ *
+ * @template T
+ * @param {T[]} arr - The array to search through.
+ * @param {(item: T, index: number, arr: T[]) => unknown} doesMatch - A function that takes an item, its index, and the array, and returns a truthy value if the item matches the criteria.
+ * @returns {number} - The index of the first item that matches the predicate, or `undefined` if no match is found.
+ *
+ * @example
+ * // Using a predicate function
+ * const items = [1, 2, 3, 4, 5];
+ * const result = find(items, (item) => item > 3);
+ * console.log(result); // 4
+ */
+declare function findIndex<T>(arr: readonly T[], doesMatch: (item: T, index: number, arr: readonly T[]) => unknown): number;
+/**
+ * Finds the index of the first item in an array that matches the given partial object.
+ *
+ * @template T
+ * @param {readonly T[]} arr - The array to search through.
+ * @param {Partial<T>} doesMatch - A partial object that specifies the properties to match.
+ * @returns {number} - The index of the first item that matches the partial object, or `undefined` if no match is found.
+ *
+ * @example
+ * // Using a partial object
+ * const items = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }];
+ * const result = findIndex(items, { name: 'Bob' });
+ * console.log(result); // 1
+ */
+declare function findIndex<T>(arr: readonly T[], doesMatch: Partial<T>): number;
+/**
+ * Finds the index of the first item in an array that matches a property with a specific value.
+ *
+ * @template T
+ * @param {readonly T[]} arr - The array to search through.
+ * @param {[keyof T, unknown]} doesMatchProperty - An array where the first element is the property key and the second element is the value to match.
+ * @returns {number} - The index of the first item that has the specified property value, or `undefined` if no match is found.
+ *
+ * @example
+ * // Using a property-value pair
+ * const items = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }];
+ * const result = findIndex(items, ['name', 'Alice']);
+ * console.log(result); // 0
+ */
+declare function findIndex<T>(arr: readonly T[], doesMatchProperty: [keyof T, unknown]): number;
+/**
+ * Finds the index of the first item in an array that has a specific property, where the property name is provided as a string.
+ *
+ * @template T
+ * @param {readonly T[]} arr - The array to search through.
+ * @param {string} propertyToCheck - The property name to check.
+ * @returns {number} - The index of the first item that has the specified property, or `undefined` if no match is found.
+ *
+ * @example
+ * // Using a property name
+ * const items = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }];
+ * const result = findIndex(items, 'name');
+ * console.log(result); // 0
+ */
+declare function findIndex<T>(arr: readonly T[], propertyToCheck: string): number;
+
+export { findIndex };

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

@@ -0,0 +1,62 @@
+/**
+ * Finds the index of the first item in an array that matches the given predicate function.
+ *
+ * @template T
+ * @param {T[]} arr - The array to search through.
+ * @param {(item: T, index: number, arr: T[]) => unknown} doesMatch - A function that takes an item, its index, and the array, and returns a truthy value if the item matches the criteria.
+ * @returns {number} - The index of the first item that matches the predicate, or `undefined` if no match is found.
+ *
+ * @example
+ * // Using a predicate function
+ * const items = [1, 2, 3, 4, 5];
+ * const result = find(items, (item) => item > 3);
+ * console.log(result); // 4
+ */
+declare function findIndex<T>(arr: readonly T[], doesMatch: (item: T, index: number, arr: readonly T[]) => unknown): number;
+/**
+ * Finds the index of the first item in an array that matches the given partial object.
+ *
+ * @template T
+ * @param {readonly T[]} arr - The array to search through.
+ * @param {Partial<T>} doesMatch - A partial object that specifies the properties to match.
+ * @returns {number} - The index of the first item that matches the partial object, or `undefined` if no match is found.
+ *
+ * @example
+ * // Using a partial object
+ * const items = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }];
+ * const result = findIndex(items, { name: 'Bob' });
+ * console.log(result); // 1
+ */
+declare function findIndex<T>(arr: readonly T[], doesMatch: Partial<T>): number;
+/**
+ * Finds the index of the first item in an array that matches a property with a specific value.
+ *
+ * @template T
+ * @param {readonly T[]} arr - The array to search through.
+ * @param {[keyof T, unknown]} doesMatchProperty - An array where the first element is the property key and the second element is the value to match.
+ * @returns {number} - The index of the first item that has the specified property value, or `undefined` if no match is found.
+ *
+ * @example
+ * // Using a property-value pair
+ * const items = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }];
+ * const result = findIndex(items, ['name', 'Alice']);
+ * console.log(result); // 0
+ */
+declare function findIndex<T>(arr: readonly T[], doesMatchProperty: [keyof T, unknown]): number;
+/**
+ * Finds the index of the first item in an array that has a specific property, where the property name is provided as a string.
+ *
+ * @template T
+ * @param {readonly T[]} arr - The array to search through.
+ * @param {string} propertyToCheck - The property name to check.
+ * @returns {number} - The index of the first item that has the specified property, or `undefined` if no match is found.
+ *
+ * @example
+ * // Using a property name
+ * const items = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }];
+ * const result = findIndex(items, 'name');
+ * console.log(result); // 0
+ */
+declare function findIndex<T>(arr: readonly T[], propertyToCheck: string): number;
+
+export { findIndex };

package/dist/compat/array/findIndex.mjs

@@ -0,0 +1,26 @@
+import { property } from '../object/property.mjs';
+import { matches } from '../predicate/matches.mjs';
+import { matchesProperty } from '../predicate/matchesProperty.mjs';
+
+function findIndex(source, doesMatch) {
+    switch (typeof doesMatch) {
+        case 'function': {
+            return source.findIndex(doesMatch);
+        }
+        case 'object': {
+            if (Array.isArray(doesMatch) && doesMatch.length === 2) {
+                const key = doesMatch[0];
+                const value = doesMatch[1];
+                return source.findIndex(matchesProperty(key, value));
+            }
+            else {
+                return source.findIndex(matches(doesMatch));
+            }
+        }
+        case 'string': {
+            return source.findIndex(property(doesMatch));
+        }
+    }
+}
+
+export { findIndex };

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

@@ -0,0 +1,21 @@
+/**
+ * Finds the index of the first occurrence of a value in an array.
+ *
+ * This method is similar to `Array.prototype.indexOf`, but it also finds `NaN` values.
+ * It uses strict equality (`===`) to compare elements.
+ *
+ * @template T - The type of elements in the array.
+ * @template U - The type of the value to search for.
+ * @param {T[] | null | undefined} array - The array to search.
+ * @param {T | U} searchElement - The value to search for.
+ * @param {number} [fromIndex] - The index to start the search at.
+ * @returns {number} The index (zero-based) of the first occurrence of the value in the array, or `-1` if the value is not found.
+ *
+ * @example
+ * const array = [1, 2, 3, NaN];
+ * indexOf(array, 3); // => 2
+ * indexOf(array, NaN); // => 3
+ */
+declare function indexOf<T, U>(array: T[] | null | undefined, searchElement: T | U, fromIndex?: number): number;
+
+export { indexOf };

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

@@ -0,0 +1,21 @@
+/**
+ * Finds the index of the first occurrence of a value in an array.
+ *
+ * This method is similar to `Array.prototype.indexOf`, but it also finds `NaN` values.
+ * It uses strict equality (`===`) to compare elements.
+ *
+ * @template T - The type of elements in the array.
+ * @template U - The type of the value to search for.
+ * @param {T[] | null | undefined} array - The array to search.
+ * @param {T | U} searchElement - The value to search for.
+ * @param {number} [fromIndex] - The index to start the search at.
+ * @returns {number} The index (zero-based) of the first occurrence of the value in the array, or `-1` if the value is not found.
+ *
+ * @example
+ * const array = [1, 2, 3, NaN];
+ * indexOf(array, 3); // => 2
+ * indexOf(array, NaN); // => 3
+ */
+declare function indexOf<T, U>(array: T[] | null | undefined, searchElement: T | U, fromIndex?: number): number;
+
+export { indexOf };

package/dist/compat/array/indexOf.mjs

@@ -0,0 +1,20 @@
+function indexOf(array, searchElement, fromIndex) {
+    if (array == null) {
+        return -1;
+    }
+    if (Number.isNaN(searchElement)) {
+        fromIndex = fromIndex ?? 0;
+        if (fromIndex < 0) {
+            fromIndex = Math.max(0, array.length + fromIndex);
+        }
+        for (let i = fromIndex; i < array.length; i++) {
+            if (Number.isNaN(array[i])) {
+                return i;
+            }
+        }
+        return -1;
+    }
+    return array.indexOf(searchElement, fromIndex);
+}
+
+export { indexOf };

package/dist/compat/index.d.mts

@@ -97,12 +97,14 @@ export { concat } from './array/concat.mjs';
 export { difference } from './array/difference.mjs';
 export { fill } from './array/fill.mjs';
 export { find } from './array/find.mjs';
+export { findIndex } from './array/findIndex.mjs';
 export { flatten } from './array/flatten.mjs';
 export { flattenDeep } from './array/flattenDeep.mjs';
 export { flattenDepth } from './array/flattenDepth.mjs';
 export { orderBy } from './array/orderBy.mjs';
 export { size } from './array/size.mjs';
 export { zipObjectDeep } from './array/zipObjectDeep.mjs';
+export { indexOf } from './array/indexOf.mjs';
 export { ary } from './function/ary.mjs';
 export { bind } from './function/bind.mjs';
 export { get } from './object/get.mjs';

package/dist/compat/index.d.ts

@@ -97,12 +97,14 @@ export { concat } from './array/concat.js';
 export { difference } from './array/difference.js';
 export { fill } from './array/fill.js';
 export { find } from './array/find.js';
+export { findIndex } from './array/findIndex.js';
 export { flatten } from './array/flatten.js';
 export { flattenDeep } from './array/flattenDeep.js';
 export { flattenDepth } from './array/flattenDepth.js';
 export { orderBy } from './array/orderBy.js';
 export { size } from './array/size.js';
 export { zipObjectDeep } from './array/zipObjectDeep.js';
+export { indexOf } from './array/indexOf.js';
 export { ary } from './function/ary.js';
 export { bind } from './function/bind.js';
 export { get } from './object/get.js';

package/dist/compat/index.js

@@ -369,6 +369,27 @@ function find(source, doesMatch) {
     }
 }
 
+function findIndex(source, doesMatch) {
+    switch (typeof doesMatch) {
+        case 'function': {
+            return source.findIndex(doesMatch);
+        }
+        case 'object': {
+            if (Array.isArray(doesMatch) && doesMatch.length === 2) {
+                const key = doesMatch[0];
+                const value = doesMatch[1];
+                return source.findIndex(matchesProperty(key, value));
+            }
+            else {
+                return source.findIndex(matches(doesMatch));
+            }
+        }
+        case 'string': {
+            return source.findIndex(property(doesMatch));
+        }
+    }
+}
+
 function flatten(value, depth = 1) {
     const result = [];
     const flooredDepth = Math.floor(depth);
@@ -525,6 +546,25 @@ function zipObjectDeep(keys, values) {
     return result;
 }
 
+function indexOf(array, searchElement, fromIndex) {
+    if (array == null) {
+        return -1;
+    }
+    if (Number.isNaN(searchElement)) {
+        fromIndex = fromIndex ?? 0;
+        if (fromIndex < 0) {
+            fromIndex = Math.max(0, array.length + fromIndex);
+        }
+        for (let i = fromIndex; i < array.length; i++) {
+            if (Number.isNaN(array[i])) {
+                return i;
+            }
+        }
+        return -1;
+    }
+    return array.indexOf(searchElement, fromIndex);
+}
+
 function ary(func, n = func.length, guard) {
     if (guard) {
         n = func.length;
@@ -853,11 +893,13 @@ exports.difference = difference;
 exports.endsWith = endsWith;
 exports.fill = fill;
 exports.find = find;
+exports.findIndex = findIndex;
 exports.flatten = flatten;
 exports.flattenDeep = flattenDeep;
 exports.flattenDepth = flattenDepth;
 exports.get = get;
 exports.has = has;
+exports.indexOf = indexOf;
 exports.isArguments = isArguments;
 exports.isArray = isArray;
 exports.isArrayLike = isArrayLike;

package/dist/compat/index.mjs

@@ -98,12 +98,14 @@ export { concat } from './array/concat.mjs';
 export { difference } from './array/difference.mjs';
 export { fill } from './array/fill.mjs';
 export { find } from './array/find.mjs';
+export { findIndex } from './array/findIndex.mjs';
 export { flatten } from './array/flatten.mjs';
 export { flattenDeep } from './array/flattenDeep.mjs';
 export { flattenDepth } from './array/flattenDepth.mjs';
 export { orderBy } from './array/orderBy.mjs';
 export { size } from './array/size.mjs';
 export { zipObjectDeep } from './array/zipObjectDeep.mjs';
+export { indexOf } from './array/indexOf.mjs';
 export { ary } from './function/ary.mjs';
 export { bind } from './function/bind.mjs';
 export { get } from './object/get.mjs';

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.15.1-dev.432+84827937",
+  "version": "1.15.1-dev.434+f55662d9",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {