partial

function

Creates a function that invokes func with partials prepended to the arguments it receives.

Installation

Import

import { partial } from '@tulx/utils';

Source Code

Implementation

/**
 * Creates a function that invokes func with partials prepended to the arguments it receives.
 *
 * @param func - The function to partially apply arguments to.
 * @param partials - The arguments to be partially applied.
 * @returns Returns the new partially applied function.
 *
 * @example
 * ```ts
 * function greet(greeting: string, name: string) {
 *   return greeting + ' ' + name;
 * }
 * const sayHelloTo = partial(greet, 'hello');
 * sayHelloTo('fred'); // 'hello fred'
 * ```
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function partial<T extends (...args: any[]) => any>(
  func: T,
  ...partials: readonly unknown[]
): (...args: unknown[]) => ReturnType<T> {
  return function (this: unknown, ...args: unknown[]): ReturnType<T> {
    return func.apply(this, [...partials, ...args]) as ReturnType<T>;
  };
}

Example

import { partial } from '@tulx/utils';

function greet(greeting: string, name: string) {
return greeting + ' ' + name;
}
const sayHelloTo = partial(greet, 'hello');
sayHelloTo('fred'); // 'hello fred'

Related Functions

after

The opposite of before; this method creates a function that invokes func once it's called n or more times.

ary

Creates a function that invokes func, with up to n arguments, ignoring any additional arguments.

before

Creates a function that invokes func, with the this binding and arguments of the created function, while it's called less than n times.

bind

Creates a function that invokes func with the this binding of thisArg and partials prepended to the arguments it receives.

bindKey

Creates a function that invokes the method at object[key] with partials prepended to the arguments it receives.

curry

Creates a function that accepts arguments of func and either invokes func returning its result, or returns a function that accepts the remaining arguments.