@types/bull

What is @types/bull?

@types/bull provides TypeScript definitions for the Bull package, which is a popular library for handling distributed job queues in Node.js applications.

What are @types/bull's main functionalities?

Creating a Queue

This feature allows you to create a new queue instance. The queue can then be used to add jobs and process them.

const Queue = require('bull');
const myQueue = new Queue('my-queue');

Adding Jobs to the Queue

This feature allows you to add jobs to the queue. Each job can contain data that will be processed by the worker.

myQueue.add({ foo: 'bar' });

Processing Jobs

This feature allows you to define a processor function that will handle the jobs added to the queue. The processor function can be asynchronous.

myQueue.process(async (job) => {
  console.log(job.data);
});

Job Events

This feature allows you to listen to various job events such as 'completed', 'failed', etc. This can be useful for logging or triggering other actions based on job status.

myQueue.on('completed', (job, result) => {
  console.log(`Job completed with result ${result}`);
});

Other packages similar to @types/bull

kue

Kue is another job queue library for Node.js. It provides a similar feature set to Bull, including job scheduling, job events, and job processing. However, Kue is less actively maintained compared to Bull.

agenda

Agenda is a lightweight job scheduling library for Node.js. It is designed to be simple and easy to use, with support for recurring jobs and job prioritization. Unlike Bull, Agenda is more focused on job scheduling rather than distributed job queues.

bee-queue

Bee-Queue is a high-performance job queue for Node.js that is designed to be simple and fast. It offers similar features to Bull, such as job processing and job events, but is optimized for high throughput and low latency.

README

This is a stub types definition for @types/bull (https://github.com/OptimalBits/bull#readme).

bull provides its own type definitions, so you don't need @types/bull installed!