@monstermann/fn/dist/option/mapOr.d.ts

A utility library for TypeScript.

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

//#region src/option/mapOr.d.ts

/**
 * `mapOr(target, map, or)`
 *
 * Applies a mapping function to a value if it's not `null` or `undefined`, otherwise returns a default value. If the target value is `null` or `undefined`, it returns the `or` value. Otherwise, it applies the mapping function and returns the result.
 *
 * ```ts
 * mapOr(5, (x) => x * 2, 0); // 10
 * mapOr(null, (x) => x * 2, 0); // 0
 * mapOr(undefined, (x) => x * 2, -1); // -1
 * ```
 *
 * ```ts
 * pipe(
 *     5,
 *     mapOr((x) => x * 2, 0),
 * ); // 10
 * pipe(
 *     null,
 *     mapOr((x) => x * 2, 0),
 * ); // 0
 * ```
 */
declare const mapOr: {
  <T, U, V>(map: (value: NoInfer<NonNil<T>>, or: V) => U): (target: T) => U | V;
  <T, U, V>(target: T, map: (value: NoInfer<NonNil<T>>) => U, or: V): U | V;
};
//#endregion
export { mapOr };