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

A utility library for TypeScript.

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

//#region src/array/findReplaceOrElse.ts
/**
* `findReplaceOrElse(array, predicate, replacement, callback)`
*
* 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 the result of calling `callback` with the array if no element is found.
*
* ```ts
* findReplaceOrElse(
*     [1, 2, 3, 4],
*     (x) => x > 10,
*     99,
*     (arr) => arr.length,
* ); // 4
* ```
*
* ```ts
* pipe(
*     [1, 2, 3, 4],
*     findReplaceOrElse(
*         (x) => x > 10,
*         99,
*         (arr) => arr.length,
*     ),
* ); // 4
* ```
*/
const findReplaceOrElse = dfdlT((target, predicate, replacement, orElse) => {
	const idx = target.findIndex(predicate);
	if (idx === -1) return orElse(target);
	const prev = target[idx];
	if (is(prev, replacement)) return target;
	const result = cloneArray(target);
	result.splice(idx, 1, replacement);
	return result;
}, 4);

//#endregion
export { findReplaceOrElse };