mirror of https://github.com/toss/es-toolkit.git synced 2024-11-24 11:45:26 +03:00

feat(debounce): Support AbortSignal to cancel debounced functions for improved cancellation (#45 )

* feat: Support AbortSignal to debounce for improved cancellation

* refactor: cancel timeoutId & add strict inequality

* fix: formatting in package.json

* refactor: using optional chaining

* fix: follow the fetch API's option

* docs: modify debounce ko, en docs

2024-06-14 08:04:05 +09:00

1.5 KiB

Raw Blame History

debounce

Creates a debounced function that delays invoking the provided function until after debounceMs milliseconds have elapsed since the last time the debounced function was invoked. The debounced function also has a cancel method to cancel any pending execution.

Signature

function debounce<F extends (...args: any[]) => void>(
  func: F,
  debounceMs: number,
  options?: DebounceOptions
): F & { cancel: () => void };

Parameters

func (F): The function to debounce.
debounceMs (number): The number of milliseconds to delay.
options (DebounceOptions, optional): An options object.
- signal (AbortSignal, optional): An optional AbortSignal to cancel the debounced function.

Returns

(F & { cancel: () => void }): A new debounced function with a cancel method.

Examples

Basic Usage

const debouncedFunction = debounce(() => {
  console.log('Function executed');
}, 1000);

// Will log 'Function executed' after 1 second if not called again in that time
debouncedFunction();

// Will not log anything as the previous call is canceled
debouncedFunction.cancel();

Using with an AbortSignal

const controller = new AbortController();
const signal = controller.signal;
const debouncedWithSignalFunction = debounce(
  () => {
    console.log('Function executed');
  },
  1000,
  { signal }
);

// Will log 'Function executed' after 1 second if not called again in that time
debouncedWithSignalFunction();

// Will cancel the debounced function call
controller.abort();

1.5 KiB Raw Blame History