docs(guide): add description

taskforcesh · Oct 9, 2024 · a1e5906 · a1e5906
1 parent 56533c7
commit a1e5906
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/docs/gitbook/guide/rate-limiting.md b/docs/gitbook/guide/rate-limiting.md
@@ -112,7 +112,22 @@ if (ttl > 0) {
 }
 ```
 
+### Remove Rate Limit Key
+
+Sometimes is useful to stop a rate limit delay.
+
+For this purpose, you can use the **`removeRateLimitKey`** method like this:
+
+```typescript
+import { Queue } from 'bullmq';
+
+const queue = new Queue('myQueue', { connection });
+
+await queue.removeRateLimitKey();
+```
+
 ## Read more:
 
 - 💡 [Rate Limit API Reference](https://api.docs.bullmq.io/classes/v5.Worker.html#rateLimit)
 - 💡 [Get Rate Limit Ttl API Reference](https://api.docs.bullmq.io/classes/v5.Queue.html#getRateLimitTtl)
+- 💡 [Remove Rate Limit Key API Reference](https://api.docs.bullmq.io/classes/v5.Queue.html#removeRateLimitKey)