Class BullBaseQueue`Abstract`

Abstract base class for all Bull-based producer queues.

All specific queue implementations should extend this class to ensure consistent behavior and reduce code duplication.

Hierarchy (View Summary)

BullBaseQueue
- BullAnalyzeQueue
- BullWebhookQueue

Implements

BaseQueue

Constructors

constructor

new BullBaseQueue(
    validator: Validator,
    config: Config,
    logger: Logger,
    connector: ProducerConnector,
    queueName: string,
): BullBaseQueue
Creates a new queue instance.
Parameters
- validator: Validator
  The validator instance.
- config: Config
  The config instance.
- logger: Logger
  The logger instance.
- connector: ProducerConnector
  The connector instance.
- queueName: string
  The queue name.
Returns BullBaseQueue

Methods

close

close(): Promise<void>

Gracefully closes the queue.

This method should be called during application shutdown.

Returns Promise<void>

Throws
LifecycleError If the queue cannot be closed properly.

Implementation of BaseQueue.close

getJobCount

getJobCount(): Promise<number>

Retrieves the total number of jobs in the queue.

Returns Promise<number>
The total job count.

Throws
ProducerError If the count cannot be retrieved.

Implementation of BaseQueue.getJobCount

getWorkers

getWorkers(): Promise<object[]>

Retrieves the workers for the queue.

Returns Promise<object[]>
The queue workers list.

Throws
ProducerError If the workers cannot be retrieved.

Implementation of BaseQueue.getWorkers