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

A utility library for TypeScript.

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

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

/**
 * `findRemoveOrElse(array, predicate, callback)`
 *
 * Finds the first element in `array` that satisfies the provided `predicate` function and removes it, returning a new array without the removed element, or the result of calling `callback` with the array if no element is found.
 *
 * ```ts
 * findRemoveOrElse(
 *     [1, 2, 3, 4],
 *     (x) => x > 10,
 *     (arr) => arr.length,
 * ); // 4
 * ```
 *
 * ```ts
 * pipe(
 *     [1, 2, 3, 4],
 *     findRemoveOrElse(
 *         (x) => x > 10,
 *         (arr) => arr.length,
 *     ),
 * ); // 4
 * ```
 */
declare const findRemoveOrElse: {
  <T, U>(predicate: ArrayPredicate<T>, orElse: OrElse<T, U>): (target: readonly T[]) => T[] | U;
  <T, U>(target: readonly T[], predicate: ArrayPredicate<T>, orElse: OrElse<T, U>): T[] | U;
};
//#endregion
export { findRemoveOrElse };