@monstermann/fn/dist/array/findMapOrThrow.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/findMapOrThrow.ts
/**
* `findMapOrThrow(array, predicate, mapper)`
*
* Finds the first element in `array` that satisfies the provided `predicate` function and applies the `mapper` function to it, returning a new array with the mapped element, or throws an error if no element is found.
*
* ```ts
* findMapOrThrow(
*     [1, 2, 3, 4],
*     (x) => x > 2,
*     (x) => x * 10,
* ); // [1, 2, 30, 4]
* ```
*
* ```ts
* pipe(
*     [1, 2, 3, 4],
*     findMapOrThrow(
*         (x) => x > 2,
*         (x) => x * 10,
*     ),
* ); // [1, 2, 30, 4]
* ```
*/
const findMapOrThrow = dfdlT((target, predicate, mapper) => {
	const idx = target.findIndex(predicate);
	if (idx === -1) throw new FnError("Array.findMapOrThrow: Value not found.", [
		target,
		predicate,
		mapper
	]);
	const prev = target[idx];
	const next = mapper(prev, idx, target);
	if (is(prev, next)) return target;
	const result = cloneArray(target);
	result.splice(idx, 1, next);
	return result;
}, 3);

//#endregion
export { findMapOrThrow };