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

A utility library for TypeScript.

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

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

/**
 * `findIndexOrThrow(target, predicate)`
 *
 * Returns the index of the first element in `target` that satisfies the provided `predicate` function. If no element satisfies the predicate, throws an error.
 *
 * ```ts
 * findIndexOrThrow([1, 2, 3, 4], (x) => x > 2); // 2
 * findIndexOrThrow([1, 2, 3, 4], (x) => x > 5); // throws FnError
 * ```
 *
 * ```ts
 * pipe(
 *     [1, 2, 3, 4],
 *     findIndexOrThrow((x) => x > 2),
 * ); // 2
 * pipe(
 *     [1, 2, 3, 4],
 *     findIndexOrThrow((x) => x > 5),
 * ); // throws FnError
 * ```
 */
declare const findIndexOrThrow: {
  <T>(predicate: ArrayPredicate<T>): (target: readonly T[]) => number;
  <T>(target: readonly T[], predicate: ArrayPredicate<T>): number;
};
//#endregion
export { findIndexOrThrow };