From b8d8886999dca42165c83ae1951edd293e8187dd Mon Sep 17 00:00:00 2001 From: Rogger Valverde Date: Thu, 22 Aug 2024 22:53:53 -0600 Subject: [PATCH] docs(debouncing): add remove debounce key sub-section (#2724) --- docs/gitbook/guide/jobs/debouncing.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/gitbook/guide/jobs/debouncing.md b/docs/gitbook/guide/jobs/debouncing.md index 276bf3a503..b4225838f8 100644 --- a/docs/gitbook/guide/jobs/debouncing.md +++ b/docs/gitbook/guide/jobs/debouncing.md @@ -44,6 +44,15 @@ This mode is particularly useful for jobs that have a long running time or those Any manual deletion will disable the debouncing. For example, when calling _job.remove_ method. {% endhint %} +## Remove Debounce Key + +If you need to stop debouncing before ttl finishes or before finishing a job. You can call **removeDebounceKey** method. + +```typescript +await myQueue.removeDebounceKey('customValue'); +``` + ## Read more: - 💡 [Add Job API Reference](https://api.docs.bullmq.io/classes/v5.Queue.html#add) +- 💡 [Remove Debounce Key API Reference](https://api.docs.bullmq.io/classes/v5.Queue.html#removeDebounceKey)