taskforcesh / bullmq

BullMQ - Message Queue and Batch processing for NodeJS and Python based on Redis
https://bullmq.io
MIT License
5.47k stars 357 forks source link

[Bug]: Documentation - incorrect parameters for queue 'cleaned' and 'waiting' events #2525

Closed oanguenot closed 1 month ago

oanguenot commented 1 month ago

Version

v5.7.1

Platform

NodeJS

What happened?

Documentation is incorrect for the 2 following events:

How to reproduce.

Listen to these events

queue.on("cleaned", (jobs) => { console.log(jobs); });

queue.on("waiting", (job) => { console.log(job); });

Relevant log output

No response

Code of Conduct

roggervalf commented 1 month ago

hi @oanguenot, I assuming you are confusing QueueListener with QueueEventsListener https://api.docs.bullmq.io/interfaces/v5.QueueListener.html#cleaned https://api.docs.bullmq.io/interfaces/v5.QueueListener.html#waiting https://api.docs.bullmq.io/interfaces/v5.QueueEventsListener.html#cleaned https://api.docs.bullmq.io/interfaces/v5.QueueEventsListener.html#waiting QueueListener is for Queue class

oanguenot commented 1 month ago

You're right. Thanks for your feedback. I will close this issue