Skip to content

Commit

Permalink
docs(pro): add local group concurrency section (#2551)
Browse files Browse the repository at this point in the history
  • Loading branch information
roggervalf authored May 14, 2024
1 parent c70708b commit cce0774
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/gitbook/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@
* [Groups](bullmq-pro/groups/README.md)
* [Rate limiting](bullmq-pro/groups/rate-limiting.md)
* [Concurrency](bullmq-pro/groups/concurrency.md)
* [Local group concurrency](bullmq-pro/groups/local-group-concurrency.md)
* [Max group size](bullmq-pro/groups/max-group-size.md)
* [Pausing groups](bullmq-pro/groups/pausing-groups.md)
* [Prioritized intra-groups](bullmq-pro/groups/prioritized.md)
Expand Down
21 changes: 21 additions & 0 deletions docs/gitbook/bullmq-pro/groups/local-group-concurrency.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Local group concurrency

It is also possible to set a specific concurrency value to a given group. This is useful if you require that different groups should run with different concurrency factors.

Please keep in mind that when specifying a group's concurrency factor, you are storing this value in Redis, so it is your responsibility to remove it if you are not using it anymore.

You can use the `setGroupConcurrency` method like this:

```typescript
import { QueuePro } from '@taskforcesh/bullmq-pro';

const queue = new QueuePro('myQueue', { connection });
const groupId = 'my group';
await queue.setGroupConcurrency(groupId, 4);
```

And you can use the `getGroupConcurrency` method like this:

```typescript
const concurrency = await queue.getGroupConcurrency(groupId);
```

0 comments on commit cce0774

Please sign in to comment.