# debounce-wrapper
> Function that calls only the last function from the chain of calls with an interval less than the specified time
[](https://www.npmjs.com/package/debounce-wrapper)
[](https://www.jsdelivr.com/package/npm/debounce-wrapper)
## Table of Contents
- [Quick start](#quick-start)
- [Install](#install)
- [Initialization](#initialization)
- [Methods](#methods)
- [debounce](#debounce)
## Quick start
### Install
We support all platforms.
#### npm
For module bundlers such as Webpack or Browserify.
```shell
npm i debounce-wrapper
```
#### Include with <script>
1. Download lib
2. Add script to html
```html
```
##### CDN
Recommended for learning purposes, you can use the latest version:
```html
```
Recommended for production for avoiding unexpected breakage from newer versions:
```html
```
### Initialization
#### ES6
debounce-wrapper as an ES6 module.
```js
import debounce from 'debounce-wrapper';
let result = [],
fn = (number) => result.push(number),
callFnWithDebounce = debounce(fn, 500)
callFnWithDebounce(1)
setTimeout(() => callFnWithDebounce(2),300)
setTimeout(() => console.log(result),350)
```
#### Node
debounce-wrapper as a Node.js module
```js
const debounce = require('debounce-wrapper');
let result = [],
fn = (number) => result.push(number),
callFnWithDebounce = debounce(fn, 500)
callFnWithDebounce(1)
setTimeout(() => callFnWithDebounce(2),300)
setTimeout(() => console.log(result),350)
```
#### Browser
Exports a global variable called `debounce`. Use it like this
Connect to html file ``````
```html
```
#### AMD
debounce-wrapper as an AMD module. Use with Require.js, System.js, and so on.
1. Download lib
2. Connect to your module loader
```js
requirejs(['debounce-wrapper'], function(debounce) {
var result = [],
fn = (number) => result.push(number),
callFnWithDebounce = debounce(fn, 500)
callFnWithDebounce(1)
setTimeout(() => callFnWithDebounce(2),300)
setTimeout(() => console.log(result),350)
});
```
## Methods
### debounce
Function wrapper, that cancels the previous function call, if time between previous and current call less than ms
#### Params
- `fn`
- Type: `function`
- Description: function that will be called after ms
- `ms`
- Type: `number`
- Description: time out, after which fn will call
#### Returns
- `NodeJS.Timeout`
#### Example
```JS
let result = [],
fn = (number) => result.push(number),
callFnWithDebounce = debounce(fn, 500)
const firstCallTimeoutId = callFnWithDebounce(1)
setTimeout(() => callFnWithDebounce(2),300)
setTimeout(() => {
console.log(firstCallTimeoutId) // => 1, timeout id that you can clear, when you need 'clearTimeout(firstCallTimeoutId)'
}, 400)
setTimeout(() => {
console.log(result) // => [2]
}, 600)
```
## Author
webster6667