throttle

throttle<T>(params): Throttled<T>

Defined in: async/throttle/index.ts:24

Creates a throttled version of a function that executes at most once every ms milliseconds.

Type Parameters

T

T extends (…args) => unknown

Parameters

params

ThrottleParams<T>

The parameters object

Returns

Throttled<T>

The throttled function with a .cancel() method

Example

const throttledFn = throttle({ fn: onScroll, ms: 100 });
window.addEventListener("scroll", throttledFn);
throttledFn.cancel(); // cancel pending trailing call

Keywords

rate limit, limit calls, scroll handler, resize handler

Throws

Error if fn is not a function

Throws

Error if ms is not a number or is negative