throttleit
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

throttleit

Throttle a function to limit its execution rate

Install

npm install throttleit

Usage

import throttle from 'throttleit';

// Throttling a function that processes data.
function processData(data) {
	console.log('Processing:', data);

	// Add data processing logic here.
}

// Throttle the `processData` function to be called at most once every 3 seconds.
const throttledProcessData = throttle(processData, 3000);

// Simulate calling the function multiple times with different data.
throttledProcessData('Data 1');
throttledProcessData('Data 2');
throttledProcessData('Data 3');

API

throttle(function, wait)

Creates a throttled function that limits calls to the original function to at most once every wait milliseconds. It guarantees execution after the final invocation and maintains the last context (this) and arguments.

function

Type: function

The function to be throttled.

wait

Type: number

The number of milliseconds to throttle invocations to.

Related

  • p-throttle - Throttle async functions
  • debounce - Delay function calls until a set time elapses after the last invocation

Package Sidebar

Install

npm i throttleit

Weekly Downloads

4,624,452

Version

2.0.0

License

MIT

Unpacked Size

4.92 kB

Total Files

5

Last publish

Collaborators

  • sindresorhus