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

A utility library for TypeScript.

import { FnError } from "../function/FnError.js";
import { dfdlT } from "@monstermann/dfdl";
import { cloneArray } from "@monstermann/remmi";

//#region src/array/findRemoveOrThrow.ts
/**
* `findRemoveOrThrow(array, predicate)`
*
* Finds the first element in `array` that satisfies the provided `predicate` function and removes it, returning a new array without the removed element, or throws an error if no element is found.
*
* ```ts
* findRemoveOrThrow([1, 2, 3, 4], (x) => x > 2); // [1, 2, 4]
* ```
*
* ```ts
* pipe(
*     [1, 2, 3, 4],
*     findRemoveOrThrow((x) => x > 2),
* ); // [1, 2, 4]
* ```
*/
const findRemoveOrThrow = dfdlT((target, predicate) => {
	const idx = target.findIndex(predicate);
	if (idx === -1) throw new FnError("Array.findRemoveOrThrow: Value not found.", [target, predicate]);
	const result = cloneArray(target);
	result.splice(idx, 1);
	return result;
}, 2);

//#endregion
export { findRemoveOrThrow };