@tempots/std

throttle() function

Creates a throttled version of a function that limits how often the function can be called.

Signature:

throttle: &lt;FN extends (...args: unknown[]) =&gt; void&gt;(delay: number, callback: FN, options?: ThrottleOptions) =&gt; ThrottledFunction&lt;Parameters&lt;FN&gt;&gt;

Parameters

Parameter	Type	Description
delay	number	Milliseconds to wait before allowing the next call.
callback	FN	The function to throttle.
options	ThrottleOptions	(Optional) Configuration options for the throttle behavior.

Returns: ThrottledFunction<Parameters<FN>>

A throttled version of the function with a cancel method.

Remarks

Throttling is useful for rate-limiting event handlers, API calls, and other expensive operations. Common delay values are 100-250ms for UI updates and 1000ms+ for API calls.

Example

// Create a throttled function that executes at most once every second
const throttledScroll = throttle(1000, () =&gt; {
  console.log('Scroll event handled');
});

// Attach to scroll event
window.addEventListener('scroll', throttledScroll);

// Cancel throttle if needed
throttledScroll.cancel();