Last active
February 25, 2022 20:35
-
-
Save beaucharman/1f93fdd7c72860736643d1ab274fee1a to your computer and use it in GitHub Desktop.
An ES6 implementation of the debounce function. "Debouncing enforces that a function not be called again until a certain amount of time has passed without it being called. As in 'execute this function only if 100 milliseconds have passed without it being called.'" - CSS-Tricks (https://css-tricks.com/the-difference-between-throttling-and-debounc…
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
function debounce(callback, wait, immediate = false) { | |
let timeout = null | |
return function() { | |
const callNow = immediate && !timeout | |
const next = () => callback.apply(this, arguments) | |
clearTimeout(timeout) | |
timeout = setTimeout(next, wait) | |
if (callNow) { | |
next() | |
} | |
} | |
} | |
/** | |
* Normal event | |
* event | | | | |
* time ---------------- | |
* callback | | | | |
* | |
* Call log only when it's been 100ms since the last sroll | |
* scroll | | | | |
* time ---------------- | |
* callback | | | |
* |100| |100| | |
*/ | |
const handleScroll = debounce((arg, event) => { | |
console.log(`${arg} ${event.type}`) | |
}, 100, true) | |
window.addEventListener('scroll', (event) => { | |
handleScroll('Event is:', event) | |
}) |
@jpenney1 I understand your example completely and I've tested my debounce function with your example, which works fine too. But I found a specific case on Reddit which your function fails.
Case:
const obj = { name: 'foo', sayMyName() { console.log('My name is', this.name) } } obj.sayMyName() //-> My name is foo obj.deb = debounce(obj.sayMyName, 1000) obj.deb() // Should log -> My name is fooWith your function,
obj
is not binded to your callback and will returnMy name is
. So unless I explicitly bind the function:obj.deb = debounce(obj.sayMyName.bind(obj), 1000) obj.deb()This will now log correctly. But the problem is that the explicit binding is somewhat unnatural, and the debounce function should handle it automatically for us.
With my function however, it logs correctly even without the explicit binding, outputtingMy name is foo
.I've done some extensive testing and so far only this test case had me scratching my head. I hope i'm not missing anything out here.
Cheers!
This help me a lot.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Works great! Thank you!