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

A utility library for TypeScript.

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

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

/**
 * `findReplaceOrThrow(array, predicate, replacement)`
 *
 * Finds the first element in `array` that satisfies the provided `predicate` function and replaces it with `replacement`, returning a new array with the replaced element, or throws an error if no element is found.
 *
 * ```ts
 * findReplaceOrThrow([1, 2, 3, 4], (x) => x > 2, 99); // [1, 2, 99, 4]
 * ```
 *
 * ```ts
 * pipe(
 *     [1, 2, 3, 4],
 *     findReplaceOrThrow((x) => x > 2, 99),
 * ); // [1, 2, 99, 4]
 * ```
 */
declare const findReplaceOrThrow: {
  <T>(predicate: ArrayPredicate<T>, replacement: NoInfer<T>): (target: T[]) => T[];
  <T>(predicate: ArrayPredicate<T>, replacement: NoInfer<T>): (target: readonly T[]) => readonly T[];
  <T>(target: T[], predicate: ArrayPredicate<T>, replacement: NoInfer<T>): T[];
  <T>(target: readonly T[], predicate: ArrayPredicate<T>, replacement: NoInfer<T>): readonly T[];
};
//#endregion
export { findReplaceOrThrow };