Socket
Socket
Sign inDemoInstall

throttleit

Package Overview
Dependencies
0
Maintainers
25
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    throttleit

Throttle a function to limit its execution rate


Version published
Weekly downloads
5.7M
increased by1.19%
Maintainers
25
Install size
4.80 kB
Created
Weekly downloads
 

Package description

What is throttleit?

The throttleit package is a utility that allows you to throttle a function, meaning it limits the rate at which a function can fire. This is particularly useful for handling repetitive events that you want to control, such as window resizing, scrolling, or keypresses in a performant way.

What are throttleit's main functionalities?

Throttling function calls

This code sample demonstrates how to use throttleit to throttle a window resize event handler. The onResize function will not be called more than once every 200 milliseconds, no matter how often the resize event fires.

const throttle = require('throttleit');

function onResize(event) {
  console.log('Window resized.');
}

window.addEventListener('resize', throttle(onResize, 200));

Other packages similar to throttleit

Readme

Source

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.

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

Keywords

FAQs

Last updated on 17 Nov 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc