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

A utility library for TypeScript.

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

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

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