www.aleph1.co.uk Git - yaffs-website/blob - node_modules/throttleit/Readme.md

   1
   2 # throttle
   3
   4   Throttle a function
   5
   6 ## Installation
   7
   8     $ component install component/throttle
   9
  10 ## Example
  11
  12     var throttle = require('throttle');
  13     window.onresize = throttle(resize, 200);
  14
  15     function resize(e) {
  16       console.log('height', window.innerHeight);
  17       console.log('width', window.innerWidth);
  18     }
  19
  20 ## API
  21
  22 ### throttle(fn, wait)
  23
  24 Creates a function that will call `fn` at most once every `wait` milliseconds.
  25
  26 Supports leading and trailing invocation.
  27
  28 `fn` will receive last context (`this`) and last arguments passed to a throttled wrapper before `fn` was invoked.
  29
  30 ## License
  31
  32   MIT