@monstermann/fn/dist/array/removeOrElse.js

A utility library for TypeScript.

import { dfdlT } from "@monstermann/dfdl";
import { cloneArray } from "@monstermann/remmi";

//#region src/array/removeOrElse.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]
* ```
*/
const removeOrElse = dfdlT((target, value, orElse) => {
	const idx = target.indexOf(value);
	if (idx < 0) return orElse(target);
	const result = cloneArray(target);
	result.splice(idx, 1);
	return result;
}, 3);

//#endregion
export { removeOrElse };