diff --git a/CHANGELOG.md b/CHANGELOG.md index 32d5e0b..ced0ddb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## v2.5.3 + +### Fixed + +- Unclear documentation on using the `debounce` function [#34](https://github.com/dhershman1/vue-debounce/issues/34) + ## v2.5.2 ### Improved diff --git a/README.md b/README.md index ca7ed73..fd081d3 100644 --- a/README.md +++ b/README.md @@ -167,12 +167,14 @@ Simply require the debounce file. import { debounce } from 'vue-debounce' ``` -And then you can use it as a function like so: +The `debounce` function returns a function back which in turn is debounced, so you can set them up ahead of time, or just double call the function like so: ```js -debounce(() => console.log('normal format'), '400ms') +const dFn = debounce(val => console.log('normal format', val), '400ms') + +dFn(10) // => 'normal format' 10 // Or -debounce(() => console.log('just a number!'), 400) +debounce(val => console.log('just a number!'), 400)(10) // => 'just a number!' 10 ``` ## Typescript Support diff --git a/package-lock.json b/package-lock.json index f0200ff..6a6d5f7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "vue-debounce", - "version": "2.5.2", + "version": "2.5.3", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index f1d8e27..6a7ede8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "vue-debounce", - "version": "2.5.2", + "version": "2.5.3", "description": "A simple vue directive for debounce", "main": "dist/vue-debounce.min.js", "types": "types/index.d.ts",