How exactly are we supposed to use QueueScheduler?

[vprasanth]

First off, I love the tool ❤️

Unforntaly, for my life, I can't find either a good example or good docs to explain how we should be instantiating a QueueScheduler.

All I can tell is I must make one for any queue where I'd like failure/retry/backOff/etc to work. So often, I have code like this that looks odd:

export const SomeQueue = new Queue<JobData, JobResult>(SOME_QUEUE_NAME, {
   connection,
   defaultJobOptions,
});
// This is needed for retry and failure capture to work! Do no remove! 🚨 
>>> new QueueScheduler(SOME_QUEUE_NAME); <<<

I simply create an instance of QueueScheduler. That's it. It just feels like magic to me 😨

Is this normal?? Any feedback here would be helpful! ty!

[manast]

I heavily recommend that you use typescript+vscode so you will get intellisense, with contextual documentation, etc. All objects in BullMQ follow the same pattern, first parameter is the queue name, second the options object. If no connection option is passed, then the default is connect to local redis, for example:

const queueScheduler = new QueueScheduler(QUEUE_NAME, { connection: { host: REDIS_HOST } })

[vprasanth]

Does that mean I can use an instance of a QueueScheduler like a Queue? Like add a job or listen for events.

[manast]

Here it is explained: https://docs.bullmq.io/guide/queuescheduler