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

A utility library for TypeScript.

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

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

/**
 * `removeOrElse(target, value, orElse)`
 *
 * Removes the first occurrence of `value` from `target` array. If the value is not found, calls the `orElse` function with the original array and returns its result.
 *
 * ```ts
 * removeOrElse([1, 2, 3, 2], 2, () => []); // [1, 3, 2]
 * removeOrElse([1, 2, 3], 4, (arr) => arr); // [1, 2, 3]
 * ```
 *
 * ```ts
 * pipe(
 *     [1, 2, 3, 2],
 *     removeOrElse(2, () => []),
 * ); // [1, 3, 2]
 *
 * pipe(
 *     [1, 2, 3],
 *     removeOrElse(4, (arr) => arr),
 * ); // [1, 2, 3]
 * ```
 */
declare const removeOrElse: {
  <T, U>(value: NoInfer<T>, orElse: OrElse<T, U>): (target: readonly T[]) => T[] | U;
  <T, U>(target: readonly T[], value: NoInfer<T>, orElse: OrElse<T, U>): T[] | U;
};
//#endregion
export { removeOrElse };