froebel/forward.d.ts

TypeScript utility library

import type { λ } from "./types";
/**
 * Given a function and its nth..last arguments, return a function accepting
 * arguments 0..n-1.
 *
 * @example
 * ```
 * const divide = (dividend: number, divisor: number) => dividend / divisor
 *
 * // (dividend: number) => number
 * const divideBy2 = forward(divide, 2)
 *
 * // prints: 0.5
 * console.log(divideBy2(1))
 * ```
 *
 * @example
 * ```
 * const fetchUrl = async (protocol: string, domain: string, path: string) =>
 *   await fetch(`${protocol}://${domain}/${path}`)
 *
 * const fetchRepo = forward(fetchUrl, 'github.com', 'MathisBullinger/froebel')
 *
 * const viaHTTPS = await fetchRepo('https')
 * ```
 */
declare const forward: <T extends λ<any[], any>, PR extends any[]>(fun: T, ...argsRight: PR) => (...argsLeft: Parameters<T> extends [...infer PL, ...PR] ? PL : never) => ReturnType<T>;
export default forward;