@monstermann/fn/dist/array/findIndex.d.ts

A utility library for TypeScript.

import { ArrayPredicate } from "./internals/types.js";

//#region src/array/findIndex.d.ts

/**
 * `findIndex(array, predicate)`
 *
 * Returns the index of the first element in `array` that satisfies the provided `predicate` function, or -1 if no element is found.
 *
 * ```ts
 * findIndex([1, 2, 3, 4], (x) => x > 2); // 2
 * ```
 *
 * ```ts
 * pipe(
 *     [1, 2, 3, 4],
 *     findIndex((x) => x > 2),
 * ); // 2
 * ```
 */
declare const findIndex: {
  <T>(predicate: ArrayPredicate<T>): (target: readonly T[]) => number;
  <T>(target: readonly T[], predicate: ArrayPredicate<T>): number;
};
//#endregion
export { findIndex };