throttle

Creates a throttled function that only invokes func at most once per every wait milliseconds

Available since v1.9.0

Import

import { throttle } from '@helpers4/function';
// or, from the all-in-one package (same code, one install):
import { throttle } from 'helpers4/function';

Signature

throttle<A extends unknown[], R>(func: function, wait: number): function

Parameters

Parameter	Type	Description
func	function	The function to throttle
wait	number	The number of milliseconds to throttle invocations to

Returns

function — The throttled function

Examples

Throttle rapid calls

The throttled function is invoked at most once per wait period.

const fn = throttle(() => console.log('tick'), 100);
fn(); // executes immediately
fn(); // ignored (within wait period)

Source

View source on GitHub