bull-qm

Queue Manager for Bull

If you use Bull, you've probably run into a situation in which the number of connections to your redis server skyrocketed. Why? Because each instance of your queues created 3 connections and each instance of your application created each queue. Easily racking up thousands of connections.

Enter the Queue Manager. At least now you can limit the number of connections a single instance makes!

QueueManager ⇐ EventEmitter

QueueManager

Kind: global class
Extends: EventEmitter

• QueueManager ⇐ EventEmitter
  • new QueueManager(bullOpts)
  • .NUM_CLIENTS ⇒ number
  • .client ⇒ IORedis
  • .subscriber ⇒ IORedis
  • .enqueue(name, data, opts) ⇒ Promise.<Job>
  • .hasQueue(name) ⇒ Boolean
  • .getQueue(name, options) ⇒ BullQueue
  • .getAllQueues() ⇒ Array.<BullQueue>
  • .shutdown() ⇒ Promise
  • .createClient(type, redisOpts) ⇒ IORedis
  • .createQueue(name, options) ⇒ BullQueue
  • .createQueue(name, options) ⇒ BullQueue

new QueueManager(bullOpts)

Param	Type	Description
bullOpts	BullOpts	The options you would normally pass to the bull queue by default

manager.NUM_CLIENTS ⇒ number

Returns the number of clients connected via this QueueManager (helper for tests)

Kind: instance property of QueueManager
Returns: number - number of clients

manager.client ⇒ IORedis

Returns the client for this QueueManager

Kind: instance property of QueueManager
Returns: IORedis - Client (used for redis cmds)

manager.subscriber ⇒ IORedis

Returns the subscriber instance for this manager. Creates it if it does not exist;

Kind: instance property of QueueManager
Returns: IORedis - Subscriber client

manager.enqueue(name, data, opts) ⇒ Promise.<Job>

Adds a job to a queue with the given name. Relies on QueueManager.getQueue which means the queue will be created. If the queue needs to have special options, make sure the queue is created by using getQueue/createQueue first.

Kind: instance method of QueueManager
Returns: Promise.<Job> - The Job created by Bull

Param	Type	Description
name	string	The name of the queue
data	Object	The data property for the new job
opts	JobOpts	Bull job options.

manager.hasQueue(name) ⇒ Boolean

Simple function to test if a queue has been created or not.

Kind: instance method of QueueManager
Returns: Boolean - True if the queue has been created, false otherwise

Param	Type	Description
name	string	The name of the queue

manager.getQueue(name, options) ⇒ BullQueue

Gets a specific queue. Creates it if the queue does not exist. If a queue needs special configuration options, they can be called on the first instance of getQueue. QueueManager.createQueue is aliased to this function, so syntactically, you can use that function to denote creation.

Kind: instance method of QueueManager
Returns: BullQueue - The created bull queue

Param	Type	Description
name	string	The name of the queue to create
options	BullOpts	Options to pass to bull. Options here will override any options provided by default.

manager.getAllQueues() ⇒ Array.<BullQueue>

Returns an array of all queues

Kind: instance method of QueueManager
Returns: Array.<BullQueue> - array of bull queues

manager.shutdown() ⇒ Promise

Closes all queues managed by this QueueManager

Kind: instance method of QueueManager
Returns: Promise - Resolves when all queues have been closed

manager.createClient(type, redisOpts) ⇒ IORedis

Manages the clients used by queues in this QueueManager instance. Bull can reuse subscriber and client connections, but needs to create separate bclient instances for each queue. This means that the number of clients you have is directly tied to the number of queues you have. You shouldn't have to use the function unless you want to reuse the IORedis connection that the Queue Manager is using

Kind: instance method of QueueManager
Returns: IORedis - An instance of IORedis
See: https://github.com/OptimalBits/bull/blob/develop/PATTERNS.md#reusing-redis-connections

Param	Type	Description
type	string	Type of redis client
redisOpts	IORedisOpts	The options to pass to redis.

manager.createQueue(name, options) ⇒ BullQueue

Gets a specific queue. Creates it if the queue does not exist. If a queue needs special configuration options, they can be called on the first instance of getQueue. QueueManager.createQueue is aliased to this function, so syntactically, you can use that function to denote creation.

Kind: instance method of QueueManager
Returns: BullQueue - The created bull queue

Param	Type	Description
name	string	The name of the queue to create
options	BullOpts	Options to pass to bull. Options here will override any options provided by default.

manager.createQueue(name, options) ⇒ BullQueue

Gets a specific queue. Creates it if the queue does not exist. If a queue needs special configuration options, they can be called on the first instance of getQueue. QueueManager.createQueue is aliased to this function, so syntactically, you can use that function to denote creation.

Kind: instance method of QueueManager
Returns: BullQueue - The created bull queue

Param	Type	Description
name	string	The name of the queue to create
options	BullOpts	Options to pass to bull. Options here will override any options provided by default.

License

© 2020 Mudrekh Goderya MIT