Quick Start

Search…
Quick Start
This is a basic guide to get your first queue working.
Install
Install using npm:
1
$ npm install bullmq
Copied!
Install using yarn:
1
$ yarn add bullmq
Copied!
Bull is written in TypeScript, and although it can be used in vanilla JavaScript, all examples in this guide will be written in TypeScript.
Import into your project and add some jobs:
1
import { Queue } from 'bullmq';
2
​
3
const myQueue = new Queue('foo');
4
​
5
async function addJobs(){
6
    await myQueue.add('myJobName', { foo: 'bar' });
7
    await myQueue.add('myJobName', { qux: 'baz' });    
8
}
9
​
10
await addJobs();
Copied!
You need to have a Redis service running in your local computer to run these examples successfully. You can read more about Redis connections here.
Jobs are added to the queue and can be processed at any time, with at least one Node.js process running a worker:
1
import { Worker } from 'bullmq'
2
​
3
const worker = new Worker(queueName, async job => {
4
    // Will print { foo: 'bar'} for the first job
5
    // and { qux: 'baz' } for the second.
6
    console.log(job.data);
7
});
Copied!
You can have as many worker processes as you want, BullMQ will distribute the jobs across your workers in a round robin fashion.
You can listen to completed (or failed) jobs by attaching listeners to the workers:
1
worker.on('completed', (job) => {
2
    console.log(`${job.id} has completed!`);
3
});
4
​
5
worker.on('failed', (job, err) => {
6
    console.log(`${job.id} has failed with ${err.message}`);
7
});
Copied!
There are many other events available, check the Guide or the API reference for more information.
Sometimes you need to listen to all the workers events in a given place, for this you need to use a special class QueueEvents:
1
import { QueueEvents } from 'bullmq'
2
​
3
const queueEvents = new QueueEvents();
4
​
5
queueEvents.on('waiting', ({ jobId }) => {
6
    console.log(`A job with ID ${jobId} is waiting`);
7
});
8
​
9
queueEvents.on('active', ({ jobId, prev }) => {
10
    console.log(`Job ${jobId} is now active; previous status was ${prev}`);
11
});
12
​
13
queueEvents.on('completed', ({ jobId, returnvalue }) => {
14
    console.log(`${jobId} has completed and returned ${returnvalue}`);
15
});
16
​
17
queueEvents.on('failed', ({ jobId, failedReason }) => {
18
    console.log(`${jobId} has failed with reason ${failedReason}`);
19
});
Copied!
You may also access the timestamp of the event, which looks like "1580456039332-0".
1
import { QueueEvents } from 'bullmq'
2
​
3
const queueEvents = new QueueEvents();
4
​
5
queueEvents.on('progress', ({ jobId, data }, timestamp) => {
6
    console.log(`${jobId} reported progress ${data} at ${timestamp}`);
7
});
Copied!
For performance reasons the events emited by a QueueEvents instance do not contain the Job instance, only the jobId. Use the Job#fromId method if you need the Job instance.
What is BullMQ
Last modified 1yr ago
Copy link