Skip to content

Commit

Permalink
Add get queue rate limit docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jasrusable committed Jun 29, 2020
1 parent 9df99fe commit 25d9ba8
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -591,6 +591,7 @@ node ./my-app.js
- [manager.pauseQueue](#managerpauseQueue)
- [manager.resumeQueue](#managerresumeQueue)
- [manager.setQueueRateLimit](#managersetqueueratelimit)
- [manager.getQueueRateLimit](#managergetqueueratelimit)
- [manager.destroyQueue](#managerdestroyQueue)
- [manager.quit](#managerquit)

Expand Down Expand Up @@ -775,6 +776,15 @@ Sets the rate limit of a queue. (100 tasks every 60 seconds)
await manager.setQueueRateLimit({ points: 100, duration: 60 });
```

#### manager.getQueueRateLimit

Gets the rate limit of a queue.

```js
const rateLimit = await manager.getQueueRateLimit();
// rateLimit = { points: 100, duration: 60 }
```

#### manager.destroyQueue

Destroys all queue data and data structures. Returns a promise.
Expand Down

0 comments on commit 25d9ba8

Please sign in to comment.