@monstermann/fn/dist/function/when.d.ts

A utility library for TypeScript.

//#region src/function/when.d.ts
/**
 * `when(predicate, onTrue)`
 *
 * Conditionally transforms a value when the predicate is true, otherwise returns the original value.
 *
 * ```ts
 * when(
 *     5,
 *     (x) => x > 3,
 *     (x) => x * 2,
 * ); // 10
 *
 * when(
 *     2,
 *     (x) => x > 3,
 *     (x) => x * 2,
 * ); // 2
 * ```
 *
 * ```ts
 * pipe(
 *     5,
 *     when(
 *         (x) => x > 3,
 *         (x) => x * 2,
 *     ),
 * ); // 10
 *
 * pipe(
 *     2,
 *     when(
 *         (x) => x > 3,
 *         (x) => x * 2,
 *     ),
 * ); // 2
 * ```
 */
declare const when: {
  <T, U extends T, V>(predicate: (value: NoInfer<T>) => value is U, onTrue: (value: NoInfer<U>) => V): (value: T) => T | V;
  <T, V>(predicate: (value: NoInfer<T>) => boolean, onTrue: (value: NoInfer<T>) => V): (value: T) => T | V;
  <T, U extends T, V>(value: T, predicate: (value: NoInfer<T>) => value is U, onTrue: (value: NoInfer<U>) => V): T | V;
  <T, V>(value: T, predicate: (value: NoInfer<T>) => boolean, onTrue: (value: NoInfer<T>) => V): T | V;
};
//#endregion
export { when };