README.zh_CN.md

English

Bull 是一个快速的，可靠的，基于 Redis 的 Node.js 队列服务。

安装

$ npm i egg-bull-queue --save

如果你使用 TypeScript：

$ npm i @types/bull --save-dev

使用

// {app_root}/config/plugin.js
exports.bull = {  // 插件名称是 'bull'
  enable: true,
  package: 'egg-bull-queue', // 包名称是 'egg-bull-queue'
};

配置

单一队列

// {app_root}/config/config.default.js
exports.bull = {
  client: {
    name: 'queue',
    redis: {
      host: 'localhost',
      port: 6379,
      db: 0,
    },
  },
};

多队列（推荐）

exports.bull = {
  clients: {
    q1: { name: 'q1' },
    q2: { name: 'q2' },
  },
  default: {
    redis: {
      host: 'localhost',
      port: 6379,
      db: 0,
    },
  },
};

用例

app.bull.process(job => {
  console.log(job.data, job1); // 'this is a job'
});

app.bull.add({ job1: 'this is a job' });

关于 Bull 的 API 和使用请阅读 Reference。

License

MIT