Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.28 KB

Readme.md

File metadata and controls

43 lines (28 loc) · 1.28 KB

raf-debounce

Build status Git tag NPM version Code style

Debounced raf (requestAnimationFrame) function

Installation

$ npm install @f/raf-debounce

Usage

var rafDebounce = require('@f/raf-debounce')
var debouncedRender = rafDebounce(render)

subscribe(debouncedRender)

API

rafDebounce(fn)

  • fn - The function you want to call no more than once every animation frame.

Returns: A debounced version of fn that runs only once every animation frame (at most). When called, that function returns a cancel function that can be used to cancel a pending debounce.

License

MIT