Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

throttle-typescript

bameyrick4.2kMIT1.1.0TypeScript support: included

Helper that returns a throttled function (TypeScript types included - works without TypeScript also)

throttle, throttled, function, typescript, types

readme

throttle-typescript

Install

You can install via npm or yarn.

npm

npm install --save throttle-typescript

yarn

yarn add throttle-typescript

Usage

You can import using ES6 imports. If you are using typescript this package includes a typings file.

import { throttle } from 'throttle-typescript';

The throttle helper takes two parameters, a function you want to throttle, and a limit (milliseconds). It will return a throttled version of that function that can be used as shown below:

function myFunction() {
    // Do the thing
}

window.addEventListener('resize', throttle(myFunction, 100));