Queueable

A versatile JavaScript utility for simplifying queue management in applications, serving as an abstraction layer over Bull, a Redis-backed queue package for Node.js. Ideal for building scalable and efficient JavaScript applications.

Why Use Queueable?

• Minimal Boilerplate Code: Avoid writing extensive code for queue instantiation, Redis connection, and cleanup. Queueable handles these tasks seamlessly for you.
• Easy to Use: Just extend the Queueable class and implement your handler method.
• Customizable: Supports custom Redis configurations through a simple queueable.config.js file.

With Queueable, you don't need to write a lot of code to:

• Get a queue instance
• Close the Redis connection after completion
• Close the queue after completion

Everything is handled efficiently within the library.

Installation

Install via npm:

npm install @abhihyder/queueable

Usage

Before using @abhihyder/queueable, make sure you have a Redis server installed and running.

const Queueable = require("@abhihyder/queueable");

class ExampleJob extends Queueable {
  handler(data) {
    console.log("Processing job with data:", data);
  }

  completed(job, result) {
    console.log(`Job ${job.id} completed with result: ${result}`);
  }

  failed(job, result) {
    console.log(`Job ${job.id} failed with result: ${result}`);
  }
}

const job = new ExampleJob();
job.dispatch({data:""});

Methods

handler(data)

You must implement this method in your derived class to define the job's main logic. The data passed to the dispatch method will be available in the handler method to perform the necessary logic.

completed(job, result) (Optional)

This method is called when a job is completed successfully. You can override it in your derived class to perform actions on job completion.

failed(job, result) (Optional)

This method is called when a job fails. You can override it in your derived class to perform actions on job failure.

Note: The methods dispatch, queueHandler, and queueInstance are reserved for internal use by the Queueable class and should not be overridden in derived classes.

Configuration

Create a queueable.config.js file in your application's root directory to customize the Redis configuration for Bull. If not provided, default configuration values will be used.

Example queueable.config.js:

module.exports = {
  redis: {
    host: "127.0.0.1",
    port: 6379,
    username: "",
    password: ""
  }
};

License

This project is licensed under the MIT License.