@solid-primitives/debounce

Creates a helpful debounce function.

Installation

npm install @solid-primitives/debounce
# or
yarn add @solid-primitives/debounce

How to use it

const fn = createDebounce((message: string) => console.log(message), 250));
fn('Hello!');
fn.clear() // clears a timeout in progress

Definition

function createDebounce<Args extends any[]>(
  func: (...args: Args) => void,
  wait?: number
): DebouncedFunction<Args>;

interface DebouncedFunction<Args extends any[]> {
  (...args: Args): void;
  clear: () => void;
}

Demo

You may view a working example here: https://codesandbox.io/s/solid-primitives-debounce-ng9bs?file=/src/index.tsx

Changelog