@monstermann/fn/dist/array/meanOrElse.d.ts

A utility library for TypeScript.

import { OrElse } from "./internals/types.js";

//#region src/array/meanOrElse.d.ts

/**
 * `meanOrElse(array, orElse)`
 *
 * Returns the mean (average) value from `array`, or calls `orElse` if the array is empty.
 *
 * ```ts
 * meanOrElse([1, 2, 3], () => 0); // 2
 * meanOrElse([], () => 0); // 0
 * ```
 *
 * ```ts
 * pipe(
 *     [1, 2, 3],
 *     meanOrElse(() => 0),
 * ); // 2
 * pipe(
 *     [],
 *     meanOrElse(() => 0),
 * ); // 0
 * ```
 */
declare const meanOrElse: {
  <T>(orElse: OrElse<number, T>): (target: readonly number[]) => number | T;
  <T>(target: readonly number[], orElse: OrElse<number, T>): number | T;
};
//#endregion
export { meanOrElse };