From 4e9abd6b0f47739b156d9a9d115c646fbce0cd29 Mon Sep 17 00:00:00 2001 From: roggervalf <rogger.valvrd@gmail.com> Date: Mon, 30 Dec 2024 11:20:35 -0500 Subject: [PATCH] docs(guide): add description for moveToWait method --- .../patterns/manually-fetching-jobs.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/gitbook/patterns/manually-fetching-jobs.md b/docs/gitbook/patterns/manually-fetching-jobs.md index dfdc5ab02f..9f8a450ef3 100644 --- a/docs/gitbook/patterns/manually-fetching-jobs.md +++ b/docs/gitbook/patterns/manually-fetching-jobs.md @@ -96,3 +96,24 @@ while (1) { } } ``` + +## Rate Limiting + +If you want to move a job back to wait because your queue is rate limited. + +```typescript +const worker = new Worker('my-queue', null, { connection, prefix }); +const token = 'my-token'; +await Job.create(queue, 'test', { foo: 'bar' }); +const job = (await worker.getNextJob(token)) as Job; + +await queue.rateLimit(60000); +await job.moveToWait(token); +``` + +## Read more: + +- 💡 [Get Next Job API Reference](https://api.docs.bullmq.io/classes/v5.Worker.html#getNextJob) +- 💡 [Move To Completed API Reference](https://api.docs.bullmq.io/classes/v5.Job.html#moveToCompleted) +- 💡 [Move To Failed API Reference](https://api.docs.bullmq.io/classes/v5.Job.html#moveToFailed) +- 💡 [Move To Wait API Reference](https://api.docs.bullmq.io/classes/v5.Job.html#moveToWait)