Skip to content

Commit

Permalink
docs(debouncing): add remove debounce key sub-section (#2724)
Browse files Browse the repository at this point in the history
  • Loading branch information
roggervalf authored Aug 23, 2024
1 parent ae0f3c3 commit b8d8886
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/gitbook/guide/jobs/debouncing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit b8d8886

Please sign in to comment.