after

function

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

Installation

Import

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

Source Code

Implementation

/**
 * The opposite of before; this method creates a function that invokes func once it's called n or more times.
 *
 * @param n - The number of calls before func is invoked.
 * @param func - The function to restrict.
 * @returns Returns the new restricted function.
 *
 * @example
 * ```ts
 * const saves = ['profile', 'settings'];
 * const done = after(saves.length, () => console.log('done saving!'));
 * saves.forEach((type) => done());
 * // Logs 'done saving!' after the two async saves have completed.
 * ```
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function after<T extends (...args: any[]) => any>(
  n: number,
  func: T
): (...args: Parameters<T>) => ReturnType<T> | undefined {
  if (n < 1) {
    return func as (...args: Parameters<T>) => ReturnType<T> | undefined;
  }

  let count = 0;
  let result: ReturnType<T> | undefined;

  return function (
    this: unknown,
    ...args: Parameters<T>
  ): ReturnType<T> | undefined {
    count++;
    if (count >= n) {
      result = func.apply(this, args) as ReturnType<T>;
    }
    return result;
  };
}

Example

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

const saves = ['profile', 'settings'];
const done = after(saves.length, () => console.log('done saving!'));
saves.forEach((type) => done());
// Logs 'done saving!' after the two async saves have completed.

Related Functions

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.

curryRight

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