tiinvo/Catch.d.ts

A library of types and utilities for your TypeScript and JavaScript projects

import type * as Fn from './Fn.js';
import type * as Functors from './Functors.js';
/**
 * Uses the `Functors.Catchable<f>` to return a wrapped function `f`.
 *
 * If the function `f` throws internally, then the functors' catch function is called, otherwise returns `f` output
 *
 * @example
 *
 * ```ts
 * import { Catch, Functors, Num } from 'tiinvo'
 *
 * function catchy(arg: number) {
 *    if (Num.isEven(arg)) {
 *      throw new TypeError("I expected an odd number :(")
 *    }
 *
 *    return arg;
 * }
 *
 * const c: Functors.CatchableModule<typeof catchy> = {
 *    [Functors.catchableSync]() {
 *      return {
 *        catch: (_error, args) => args[0] - 1,
 *        func: catchy,
 *      }
 *    }
 * }
 *
 * const catched = Catch.make(c);
 *
 * catched(10)                    // 9
 * catched(7)                     // 7
 * ```
 *
 * @template F the function to catch
 * @param catchable the CatchableModule<F>
 * @returns a unary function
 * @since 4.0.0
 */
export declare const make: <F extends Fn.AnyFn>(catchable: Functors.CatchableModule<F>) => F extends Fn.AnyAsyncFn ? (...args: Parameters<F>) => Promise<Awaited<ReturnType<F>>> : (...args: Parameters<F>) => ReturnType<F>;