Code Monkey home page Code Monkey logo

throttle's Introduction

throttle

Restrict how frequently a function may be invoked.

Note:

The original implemenation comes from underscore, except just to be a pain, I've flipped the argument order so the function always comes last. This is to prevent hard to read, dangling arguments when using anonymous functions or long function invocations, such as when using bind.

Plans: Dump confusing underscore implementation + implement fluent interface. Interface very likely to change.

Installation

$ component install timoxley/throttle

Example

  var throttle = require('throttle')
  window.addEventListener('scroll', throttle(1000, function() {
    console.log('I should only happen once every second.')
  }))
  window.addEventListener('scroll', throttle(2000, function() {
    console.log('I should only happen once every two seconds.')
  }))

API

throttle(wait, fn)

Returns a new function that wraps the supplied fn, blocking calls to fn until wait milliseconds have elapsed.

throttle.debounce(wait, immediate, fn)

Returns a function, that, as long as it continues to be invoked, will not be triggered. The function will be called after it stops being called for wait milliseconds.

License

MIT

throttle's People

Contributors

timoxley avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.