rest

function

Creates a function that invokes func with the this binding of the created function and arguments from start and beyond provided as an array.

Try in Playground

Installation

Import

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

Source Code

Implementation

/**
 * Creates a function that invokes func with the this binding of the created function and arguments from start and beyond provided as an array.
 *
 * @param func - The function to apply a rest parameter to.
 * @param start - The start position of the rest parameter.
 * @returns Returns the new function.
 *
 * @example
 * ```ts
 * const say = rest((what: string, names: string[]) => what + ' ' + names.join(', '));
 * say('hello', 'fred', 'barney', 'pebbles'); // 'hello fred, barney, pebbles'
 * ```
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function rest<T extends (...args: any[]) => any>(
  func: T,
  start: number = func.length - 1
): (...args: unknown[]) => ReturnType<T> {
  return function (this: unknown, ...args: unknown[]): ReturnType<T> {
    const normalArgs = args.slice(0, start);
    const restArgs = args.slice(start);
    return func.apply(this, [...normalArgs, restArgs]) as ReturnType<T>;
  };
}

Example

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

const say = rest((what: string, names: string[]) => what + ' ' + names.join(', '));
say('hello', 'fred', 'barney', 'pebbles'); // 'hello fred, barney, pebbles'

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.