@zkochan/pnpm
Version:
A fast implementation of npm install
40 lines (23 loc) • 1.07 kB
Markdown
# debounce
Useful for implementing behavior that should only happen after a repeated action has completed.
## Installation
$ component install component/debounce
Or in node:
$ npm install debounce
## Example
```js
var debounce = require('debounce');
window.onresize = debounce(resize, 200);
function resize(e) {
console.log('height', window.innerHeight);
console.log('width', window.innerWidth);
}
```
## API
### debounce(fn, wait, [ immediate || false ])
Creates and returns a new debounced version of the passed function that will postpone its execution until after wait milliseconds have elapsed since the last time it was invoked.
Pass `true` for the `immediate` parameter to cause debounce to trigger the function on the leading edge instead of the trailing edge of the wait interval. Useful in circumstances like preventing accidental double-clicks on a "submit" button from firing a second time.
## License
MIT
Original implementation is from [`underscore.js`](http://underscorejs.org/)
which also has an MIT license.