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

A utility library for TypeScript.

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

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

/**
 * `findIndexOrElse(target, predicate, orElse)`
 *
 * Returns the index of the first element in `target` that satisfies the provided `predicate` function. If no element satisfies the predicate, calls `orElse` with the original array.
 *
 * ```ts
 * findIndexOrElse(
 *     [1, 2, 3, 4],
 *     (x) => x > 2,
 *     () => -1,
 * ); // 2
 * findIndexOrElse(
 *     [1, 2, 3, 4],
 *     (x) => x > 5,
 *     (arr) => arr.length,
 * ); // 4
 * ```
 *
 * ```ts
 * pipe(
 *     [1, 2, 3, 4],
 *     findIndexOrElse(
 *         (x) => x > 2,
 *         () => -1,
 *     ),
 * ); // 2
 * pipe(
 *     [1, 2, 3, 4],
 *     findIndexOrElse(
 *         (x) => x > 5,
 *         (arr) => arr.length,
 *     ),
 * ); // 4
 * ```
 */
declare const findIndexOrElse: {
  <T, U>(predicate: ArrayPredicate<T>, orElse: OrElse<T, U>): (target: readonly T[]) => number | U;
  <T, U>(target: readonly T[], predicate: ArrayPredicate<T>, orElse: OrElse<T, U>): number | U;
};
//#endregion
export { findIndexOrElse };