es-toolkit 1.15.1-dev.431 → 1.15.1-dev.433

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/index.d.mts

@@ -97,6 +97,7 @@ 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';

package/dist/compat/index.d.ts

@@ -97,6 +97,7 @@ 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';

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);
@@ -853,6 +874,7 @@ exports.difference = difference;
 exports.endsWith = endsWith;
 exports.fill = fill;
 exports.find = find;
+exports.findIndex = findIndex;
 exports.flatten = flatten;
 exports.flattenDeep = flattenDeep;
 exports.flattenDepth = flattenDepth;

package/dist/compat/index.mjs

@@ -98,6 +98,7 @@ 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';

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.431+4bc1fa87",
+  "version": "1.15.1-dev.433+c9587f38",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {