ary

function

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

Installation

Import

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

Source Code

Implementation

/**
 * Creates a function that invokes func, with up to n arguments, ignoring any additional arguments.
 *
 * @param func - The function to cap arguments for.
 * @param n - The arity cap.
 * @returns Returns the new capped function.
 *
 * @example
 * ```ts
 * map(['6', '8', '10'], ary(parseInt, 1)); // [6, 8, 10]
 * ```
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function ary<T extends (...args: any[]) => any>(
  func: T,
  n: number
): (...args: Parameters<T>) => ReturnType<T> {
  return function (this: unknown, ...args: Parameters<T>): ReturnType<T> {
    return func.apply(this, args.slice(0, n)) as ReturnType<T>;
  };
}

Example

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

map(['6', '8', '10'], ary(parseInt, 1)); // [6, 8, 10]

Related Functions

after

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

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.

curryRight

This method is like curry except that arguments are applied to func in the manner of partialRight instead of partial.