egg-bull-new
v2.0.1
Published
bull plugin for egg framework
Maintainers
Readme
egg-bull-new
Bull (Redis) queue plugin for Egg.
Compatibility
Starting from 2.x this plugin targets Egg 4:
| Dependency | Version |
| --- | --- |
| egg | ^4.2.0 (peer dependency) |
| node | >= 22.18.0 |
The plugin is registered as an Egg 4 boot hook: the bull singleton is created
during didLoad and app/queue/** is loaded during willReady, so every queue
is available before app.ready() resolves.
For Egg 3 use [email protected].
Install
$ npm i egg-bull-new --saveUsage
// {app_root}/config/plugin.ts
import { EggPlugin } from 'egg';
const plugin: EggPlugin = {
bull: {
enable: true,
package: 'egg-bull-new',
},
};
export default plugin;Configuration
Single queue
// {app_root}/config/config.default.js
exports.bull = {
client: {
name: 'queue',
redis: {
host: 'localhost',
port: 6379,
db: 0,
},
},
};Multiple queue (recommended)
exports.bull = {
clients: {
q1: { name: 'q1' },
q2: { name: 'q2' },
},
default: {
redis: {
host: 'localhost',
port: 6379,
db: 0,
},
},
};default is merged into every client, so shared redis/job options only need to be
written once. Note that the merge is shallow: a defaultJobOptions defined on a
client replaces the whole default.defaultJobOptions object.
The plugin also exposes its own config.queue knobs — delegate (default
queue), baseDir (default queue), app (default true) and agent
(default false) — which control where app/queue/** is loaded from and whether
the queues are created in the application worker or the agent worker. See
config/config.default.js for more detail.
Example
// {app_root}/app/queue/video.js
module.exports = app => {
const queue = app.bull.get('videoQueue');
queue.process((job, done) => {
job.progress(42);
done();
});
return queue;
};
// {app_root}/app/controller/video.js
async function (ctx) {
await ctx.queue.video.add({ video: 'http://example.com/video1.mov' });
};Every file under app/queue/** is loaded onto app.queue and ctx.queue, keyed
by file name. Queues that are not registered in config.bull.clients (such as a
queue created with new app.Queue(name, opts)) are supported as well.
For Bull's api read Reference for more details.
Test
$ npm testThe tests need a local Redis listening on 127.0.0.1:6379 with the password
foobared:
$ docker run -d --name redis -p 6379:6379 redis:7 redis-server --requirepass foobared