Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LuxChanLu/moleculer-bullmq
A moleculer module for BullMQ (https://docs.bullmq.io/)
https://github.com/LuxChanLu/moleculer-bullmq
bullmq javascript moleculer moleculerjs
Last synced: 2 months ago
JSON representation
A moleculer module for BullMQ (https://docs.bullmq.io/)
- Host: GitHub
- URL: https://github.com/LuxChanLu/moleculer-bullmq
- Owner: LuxChanLu
- License: mit
- Created: 2020-01-30T02:46:40.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-28T19:14:29.000Z (about 2 years ago)
- Last Synced: 2024-05-22T07:52:56.158Z (8 months ago)
- Topics: bullmq, javascript, moleculer, moleculerjs
- Language: JavaScript
- Homepage:
- Size: 413 KB
- Stars: 13
- Watchers: 2
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-moleculer - moleculer-bullmq - Task queue mixin for [BullMq](https://github.com/taskforcesh/bullmq) (Mixins / Tasks, Queues and Jobs)
README
# moleculer-bullmq
[](https://coveralls.io/github/LuxChanLu/moleculer-bullmq?branch=master)
[](https://www.codacy.com/app/LuxChanLu/moleculer-bullmq?utm_source=github.com&utm_medium=referral&utm_content=LuxChanLu/moleculer-bullmq&utm_campaign=Badge_Grade)
[](https://codeclimate.com/github/LuxChanLu/moleculer-bullmq/maintainability)
[](https://www.npmjs.com/package/moleculer-bullmq)
## How to create job
You just need to add the `BullMqMixin` and add a `queue` attribute to you action.
This action will be call with the params & meta of the scheduler.
The return of the action will be the job result.
The mixin will add the BullMq `job` into `locals`
```js
module.exports = {
name: 'jobs',
mixins: [BullMqMixin],
settings: {
bullmq: {
worker: { concurrency: 50 }
}
},
actions: {
resize: {
queue: true,
params: { width: 'number', height: 'number' },
async handler(ctx) {
const { width, height } = ctx.params
const { user } = ctx.meta
ctx.locals.job.updateProgress(100)
return { user, size: width * height, job: ctx.locals.job.id }
}
}
}
}
```
By default it use the redis cacher, but you can specify a custom client :
```js
module.exports = {
name: 'jobs',
mixins: [BullMqMixin],
settings: {
bullmq: {
client: 'redis://:[email protected]:6380/4'
}
}
}
The `client` option goes to the `IORedis` constructor.
```
## How to queue job
You can use the `queue` method, with five parameters : Current context, Queue name, Action name, Parameters, Job options
```js
module.exports = {
name: 'my.service',
mixins: [BullMqMixin],
actions: {
'resize.async': {
async handler(ctx) {
ctx.meta.user = 'Bob de glace'
const job = await this.queue(ctx, 'jobs', 'resize', { width: 42, height: 42 }, { priority: 10 })
}
}
}
}
```
If your in the same service as your scheduling action, you can omit the queue name with the `localQueue` method
```js
module.exports = {
name: 'my.service',
mixins: [BullMqMixin],
actions: {
resize: {
queue: true,
params: { width: 'number', height: 'number' },
async handler(ctx) {
const { width, height } = ctx.params
const { user } = ctx.meta
ctx.locals.job.updateProgress(100)
return { user, size: width * height, job: ctx.locals.job.id }
}
},
'resize.async': {
async handler(ctx) {
ctx.meta.user = 'Bob de glace'
const job = await this.localQueue(ctx, 'resize', { width: 42, height: 42 }, { priority: 10 })
}
}
}
}
```