Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Debounce example is confusing / misleading #689

Closed
dobesv opened this issue Aug 18, 2021 · 3 comments · Fixed by #961
Closed

Debounce example is confusing / misleading #689

dobesv opened this issue Aug 18, 2021 · 3 comments · Fixed by #961
Labels

Comments

@dobesv
Copy link

dobesv commented Aug 18, 2021

Looking at https://docs.bullmq.io/patterns/debounce-jobs

This doesn't seem to be a debounce. With a debounce, the timer is reset every time a new job is added. However, in the example it would run a single job after 1 seconds.

Also, the example says in the comment that the job would be delayed at least 5 seconds but the delay is set to 1 second for each job that is added, which is also confusing

Possible fixes:

  • Update title to say "Throttling jobs"
  • Update comments to say "delay at least one second"
@roggervalf
Copy link
Collaborator

Related to #950

@manast
Copy link
Contributor

manast commented Dec 18, 2021

@dobesv Yes you are definitively right about the terminology, this is not a debounce but a throttle.

@github-actions
Copy link

🎉 This issue has been resolved in version 1.60.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants