# debounce-wrapper

> Function wrapper, that cancels the previous function call, if time between previous and current call less than ms

Latest version **1.0.6** (published 2021-07-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install debounce-wrapper
pnpm add debounce-wrapper
yarn add debounce-wrapper
bun add debounce-wrapper
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2021-07-26 |
| First published | 2021-07-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 20.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | webster6667 |
| Maintainers | webster6667 |
| Keywords | debounce |

## Links

- npm: https://www.npmjs.com/package/debounce-wrapper
- Repository: https://github.com/webster6667/debounce-wrapper
- Homepage: https://github.com/webster6667/debounce-wrapper#readme
- Issues: https://github.com/webster6667/debounce-wrapper/issues
- npm.io page: https://npm.io/package/debounce-wrapper

## Dependencies (1)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.14.0

## Recent versions

- 1.0.6 (latest) — 2021-07-26
- 1.0.5 — 2021-07-26
- 1.0.4 — 2021-07-16
- 1.0.3 — 2021-07-16
- 1.0.2 — 2021-07-15
- 1.0.1 — 2021-07-15
- 1.0.0 — 2021-07-15

## README

<p align="center" style="text-align:center">
    <img src="./illustration.svg" alt="illustration" width="100"/>
</p>

# debounce-wrapper

> Function that calls only the last function from the chain of calls with an interval less than the specified time

[![npm version](https://badge.fury.io/js/debounce-wrapper.svg)](https://www.npmjs.com/package/debounce-wrapper)
[![](https://data.jsdelivr.com/v1/package/npm/debounce-wrapper/badge)](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 &lt;script&gt;

1. <a href="https://cdn.jsdelivr.net/npm/debounce-wrapper/dist/lib/debounce-wrapper.js" target="_blank">Download lib</a>
2. Add script to html

```html
<script src="debounce-wrapper.js"></script>
```

##### CDN

Recommended for learning purposes, you can use the latest version:

```html
<script src="https://cdn.jsdelivr.net/npm/debounce-wrapper/dist/lib/debounce-wrapper.js"></script>
```

Recommended for production for avoiding unexpected breakage from newer versions:

```html
<script src="https://cdn.jsdelivr.net/npm/debounce-wrapper@0.0.0/dist/lib/debounce-wrapper.js"></script>
```

### 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 ```<script src="https://cdn.jsdelivr.net/npm/debounce-wrapper/dist/lib/debounce-wrapper.js" ></script>```

```html
<script>

    var result = [],
        fn = (number) => result.push(number),
        callFnWithDebounce = debounce(fn, 500)

    callFnWithDebounce(1)
    setTimeout(() => callFnWithDebounce(2),300)

    setTimeout(() => console.log(result),350)

</script>
```

#### AMD

debounce-wrapper as an AMD module. Use with Require.js, System.js, and so on.

1. <a href="https://cdn.jsdelivr.net/npm/debounce-wrapper/dist/lib/debounce-wrapper.js" target="_blank">Download lib</a>
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

---
_Source: https://npm.io/package/debounce-wrapper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._