bindKey

function

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

Installation

Import

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

Source Code

Implementation

/**
 * Creates a function that invokes the method at object[key] with partials prepended to the arguments it receives.
 *
 * @param object - The object to invoke the method on.
 * @param key - The key of the method.
 * @param partials - The arguments to be partially applied.
 * @returns Returns the new bound function.
 *
 * @example
 * ```ts
 * const object = {
 *   'user': 'fred',
 *   'greet': function(greeting: string, punctuation: string) {
 *     return greeting + ' ' + this.user + punctuation;
 *   }
 * };
 * const bound = bindKey(object, 'greet', 'hi');
 * bound('!'); // 'hi fred!'
 * ```
 */
export function bindKey(
  object: Record<string, unknown>,
  key: string,
  ...partials: readonly unknown[]
): (...args: unknown[]) => unknown {
  return function (this: unknown, ...args: unknown[]): unknown {
    const method = object[key];
    if (typeof method !== 'function') {
      throw new TypeError(`Expected a function at key "${key}"`);
    }
    return method.apply(object, [...partials, ...args]);
  };
}

Example

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

const object = {
'user': 'fred',
'greet': function(greeting: string, punctuation: string) {
return greeting + ' ' + this.user + punctuation;
}
};
const bound = bindKey(object, 'greet', 'hi');
bound('!'); // 'hi 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.

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.