File: Readme.md

package info (click to toggle)
node-throttleit 1.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 108 kB
  • sloc: makefile: 19; sh: 2
file content (32 lines) | stat: -rw-r--r-- 611 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# throttle

  Throttle a function

## Installation

    $ component install component/throttle

## Example

    var throttle = require('throttle');
    window.onresize = throttle(resize, 200);

    function resize(e) {
      console.log('height', window.innerHeight);
      console.log('width', window.innerWidth);
    }

## API

### throttle(fn, wait)

Creates a function that will call `fn` at most once every `wait` milliseconds.

Supports leading and trailing invocation.

`fn` will receive last context (`this`) and last arguments passed to a throttled wrapper before `fn` was invoked.

## License

  MIT