spread

function

Creates a function that invokes func with the array of arguments provided to the created function.

Installation

Import

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

Source Code

Implementation

/**
 * Creates a function that invokes func with the array of arguments provided to the created function.
 *
 * @param func - The function to spread arguments over.
 * @param start - The start position of the spread.
 * @returns Returns the new function.
 *
 * @example
 * ```ts
 * const say = spread((who: string, what: string) => who + ' says ' + what);
 * say(['fred', 'hello']); // 'fred says hello'
 * ```
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function spread<T extends (...args: any[]) => any>(
  func: T,
  start: number = 0
): (args: readonly unknown[]) => ReturnType<T> {
  return function (this: unknown, args: readonly unknown[]): ReturnType<T> {
    return func.apply(this, args.slice(start)) as ReturnType<T>;
  };
}

Example

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

const say = spread((who: string, what: string) => who + ' says ' + what);
say(['fred', 'hello']); // 'fred says hello'

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.