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

A utility library for TypeScript.

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

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

/**
 * `findMapOrThrow(array, predicate, mapper)`
 *
 * Finds the first element in `array` that satisfies the provided `predicate` function and applies the `mapper` function to it, returning a new array with the mapped element, or throws an error if no element is found.
 *
 * ```ts
 * findMapOrThrow(
 *     [1, 2, 3, 4],
 *     (x) => x > 2,
 *     (x) => x * 10,
 * ); // [1, 2, 30, 4]
 * ```
 *
 * ```ts
 * pipe(
 *     [1, 2, 3, 4],
 *     findMapOrThrow(
 *         (x) => x > 2,
 *         (x) => x * 10,
 *     ),
 * ); // [1, 2, 30, 4]
 * ```
 */
declare const findMapOrThrow: {
  <T, U extends T>(predicate: ArrayGuard<T, U>, mapper: ArrayMap<T>): (target: T[]) => T[];
  <T, U extends T>(predicate: ArrayGuard<T, U>, mapper: ArrayMap<T>): (target: readonly T[]) => readonly T[];
  <T>(predicate: ArrayPredicate<T>, mapper: ArrayMap<T>): (target: T[]) => T[];
  <T>(predicate: ArrayPredicate<T>, mapper: ArrayMap<T>): (target: readonly T[]) => readonly T[];
  <T, U extends T>(target: T[], predicate: ArrayGuard<T, U>, mapper: ArrayMap<T>): T[];
  <T, U extends T>(target: readonly T[], predicate: ArrayGuard<T, U>, mapper: ArrayMap<T>): readonly T[];
  <T>(target: T[], predicate: ArrayPredicate<T>, mapper: ArrayMap<T>): T[];
  <T>(target: readonly T[], predicate: ArrayPredicate<T>, mapper: ArrayMap<T>): readonly T[];
};
//#endregion
export { findMapOrThrow };