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

A utility library for TypeScript.

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

//#region src/array/meanOr.ts
/**
* `meanOr(array, fallback)`
*
* Returns the mean (average) value of the number `array`, or `fallback` if the array is empty.
*
* ```ts
* meanOr([1, 2, 3, 4], 0); // 2.5
* ```
*
* ```ts
* pipe([1, 2, 3, 4], meanOr(0)); // 2.5
* ```
*/
const meanOr = dfdlT((target, or) => {
	if (target.length === 0) return or;
	return target.reduce((acc, val) => acc + val, 0) / target.length;
}, 2);

//#endregion
export { meanOr };