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

A utility library for TypeScript.

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

//#region src/array/findReplaceOrThrow.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]
* ```
*/
const findReplaceOrThrow = dfdlT((target, predicate, replacement) => {
	const idx = target.findIndex(predicate);
	if (idx === -1) throw new FnError("Array.findReplaceOrThrow: Value not found.", [
		target,
		predicate,
		replacement
	]);
	const prev = target[idx];
	if (is(prev, replacement)) return target;
	const result = cloneArray(target);
	result.splice(idx, 1, replacement);
	return result;
}, 3);

//#endregion
export { findReplaceOrThrow };