https://github.com/choojs/nanobounce
Smol debounce package
https://github.com/choojs/nanobounce
Last synced: 12 months ago
JSON representation
Smol debounce package
- Host: GitHub
- URL: https://github.com/choojs/nanobounce
- Owner: choojs
- License: mit
- Created: 2017-04-01T18:34:46.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-07-11T15:07:23.000Z (almost 5 years ago)
- Last Synced: 2025-06-18T05:43:48.965Z (12 months ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 20
- Watchers: 1
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nanobounce [![stability][0]][1]
[![npm version][2]][3] [![build status][4]][5]
[![downloads][8]][9] [![js-standard-style][10]][11]
Smol debounce package.
## Usage
```js
var Nanobounce = require('nanobounce')
var html = require('bel')
var nanobounce = Nanobounce()
html`
click me
`
function onkeydown (e) {
var value = e.target.value
nanobounce(function () {
console.log('called at the start of a new frame', value)
})
}
```
## Why?
Because most debounce functions don't work well when doing DOM diffing. This
package is specifically made to work well with DOM diffing.
## API
### `nanobounce = Nanobounce([timeout])`
Create a new instance. Timeout defaults to `256ms`.
### `nanobounce(callback)`
Debounce a callback for the duration of the timeout. The last callback wins if
called multiple times in a row.
## License
[MIT](https://tldrlegal.com/license/mit-license)
[0]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square
[1]: https://nodejs.org/api/documentation.html#documentation_stability_index
[2]: https://img.shields.io/npm/v/nanobounce.svg?style=flat-square
[3]: https://npmjs.org/package/nanobounce
[4]: https://img.shields.io/travis/yoshuawuyts/nanobounce/master.svg?style=flat-square
[5]: https://travis-ci.org/yoshuawuyts/nanobounce
[6]: https://img.shields.io/codecov/c/github/yoshuawuyts/nanobounce/master.svg?style=flat-square
[7]: https://codecov.io/github/yoshuawuyts/nanobounce
[8]: http://img.shields.io/npm/dm/nanobounce.svg?style=flat-square
[9]: https://npmjs.org/package/nanobounce
[10]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[11]: https://github.com/feross/standard