@three11/debounce
Advanced tools
Comparing version 0.3.0 to 0.4.0
{ | ||
"name": "@three11/debounce", | ||
"version": "0.3.0", | ||
"version": "0.4.0", | ||
"description": "Debounce multiple function executions", | ||
"main": "dist/index.js", | ||
"main": "dist/debounce.js", | ||
"scripts": { | ||
@@ -17,3 +17,3 @@ "build": "webpack" | ||
"name": "Three 11 Ltd", | ||
"email": "contact.three11@gmail.com", | ||
"email": "hello@three-11.com", | ||
"role": "Developer" | ||
@@ -38,11 +38,11 @@ }, | ||
"devDependencies": { | ||
"@babel/cli": "^7.0.0-beta.44", | ||
"@babel/core": "^7.0.0-beta.44", | ||
"@babel/preset-env": "^7.0.0-beta.44", | ||
"@babel/preset-stage-2": "^7.0.0-beta.44", | ||
"@babel/cli": "^7.0.0-beta.52", | ||
"@babel/core": "^7.0.0-beta.52", | ||
"@babel/preset-env": "^7.0.0-beta.52", | ||
"@babel/preset-stage-2": "^7.0.0-beta.52", | ||
"babel-loader": "^8.0.0-beta", | ||
"unminified-webpack-plugin": "^2.0.0", | ||
"webpack": "^4.5.0", | ||
"webpack-cli": "^2.0.14" | ||
"webpack": "^4.15.1", | ||
"webpack-cli": "^3.0.8" | ||
} | ||
} |
@@ -0,1 +1,20 @@ | ||
[![GitHub stars](https://img.shields.io/github/stars/three11/debounce.svg?style=social&label=Stars)](https://github.com/three11/debounce) | ||
[![GitHub forks](https://img.shields.io/github/forks/three11/debounce.svg?style=social&label=Fork)](https://github.com/three11/debounce/network#fork-destination-box) | ||
[![GitHub release](https://img.shields.io/github/release/three11/debounce.svg)](https://github.com/three11/debounce/releases/latest) | ||
[![GitHub issues](https://img.shields.io/github/issues/three11/debounce.svg)](https://github.com/three11/debounce/issues) | ||
[![GitHub last commit](https://img.shields.io/github/last-commit/three11/debounce.svg)](https://github.com/three11/debounce/commits/master) | ||
[![Github file size](https://img.shields.io/github/size/three11/debounce/dist/index.min.js.svg)](https://github.com/three11/debounce/) | ||
[![Build Status](https://travis-ci.org/three11/debounce.svg?branch=master)](https://travis-ci.org/three11/debounce) | ||
[![npm](https://img.shields.io/npm/dt/@three11/debounce.svg)](https://www.npmjs.com/package/@three11/debounce) | ||
[![npm](https://img.shields.io/npm/v/@three11/debounce.svg)](https://www.npmjs.com/package/@three11/debounce) | ||
[![license](https://img.shields.io/github/license/three11/debounce.svg)](https://github.com/three11/debounce) | ||
[![Analytics](https://ga-beacon.appspot.com/UA-83446952-1/github.com/three11/debounce/README.md)](https://github.com/three11/debounce/) | ||
[![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/three11/debounce/) | ||
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/three11/debounce/graphs/commit-activity) | ||
[![Greenkeeper badge](https://badges.greenkeeper.io/three11/debounce.svg)](https://greenkeeper.io/) | ||
[![dependencies Status](https://david-dm.org/three11/debounce/status.svg)](https://david-dm.org/three11/debounce) | ||
[![devDependencies Status](https://david-dm.org/three11/debounce/dev-status.svg)](https://david-dm.org/three11/debounce?type=dev) | ||
[![ForTheBadge built-with-love](https://ForTheBadge.com/images/badges/built-with-love.svg)](https://github.com/three11/) | ||
# Debounce | ||
@@ -7,3 +26,3 @@ | ||
``` | ||
```sh | ||
npm i @three11/debounce | ||
@@ -14,6 +33,22 @@ ``` | ||
``` | ||
```sh | ||
yarn add @three11/debounce | ||
``` | ||
or | ||
Just download this repository and link the files located in dist folder: | ||
```html | ||
<script src="path-to-debounce/dist/debounce.min.js"></script> | ||
``` | ||
or | ||
Include it from Unpkg CDN | ||
```html | ||
<script src="//unpkg.com/@three11/debounce/dist/debounce.min.js"></script> | ||
``` | ||
## Usage | ||
@@ -23,3 +58,3 @@ | ||
``` | ||
```javascript | ||
import debounce from '@three11/debounce'; | ||
@@ -30,3 +65,3 @@ ``` | ||
``` | ||
```javascript | ||
debounce(yourAwesomeFn()); | ||
@@ -39,5 +74,5 @@ ``` | ||
* `fn` : <Function> - the function to debounce | ||
* `wait` : <Number> - miliseconds to wait before running the `fn` again | ||
* `immediate` : <Boolean> - whether the function should run immediately | ||
- `fn` : the function to debounce | ||
- `wait` : miliseconds to wait before running the `fn` again | ||
- `immediate` : whether the function should run immediately | ||
@@ -44,0 +79,0 @@ ## License |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
77
46033
6
151
1