tsui66 / egg-bullmq

Bullmq plugin for Egg.js

egg-bullmq

依赖说明

依赖的 egg 版本

egg-bullmq 版本	egg 1.x
1.x	😁
0.x	❌

依赖的插件

开启插件

// config/plugin.js
exports.bullmq = {
  enable: true,
  package: 'egg-bullmq',
};

使用场景

• 定时任务
• 工作流

目录结构 &

.
├── app
│   ├── schedule
│   │   └── workflow.js
│   └── router.js

消费者

// /app/schedule/comsumer.js

module.exports = app => {
  return {
    schedule: {
      type: 'queue | workflow', // 扩展定时任务类型, 具体参考 [Egg.js Schedule](https://Quinton.org/zh-cn/basics/schedule.html#%E6%89%A9%E5%B1%95%E5%AE%9A%E6%97%B6%E4%BB%BB%E5%8A%A1%E7%B1%BB%E5%9E%8B)
      // below are self-defined args
      queue: 'speed_test',
      prefix: 'com.task.workflow',
      pattern: 'workflow',
    },
    // schedule 就是上面的 schedule
    async task(ctx, { schedule: { queueName }, msg, ackEvent }) {
      // do something stuff
    },
  };
};

详细配置

请到 config/config.default.js 查看详细配置项说明。

单元测试

提问交流

请到 egg issues 异步交流。

License

MIT