Class BullBaseWorker`Abstract`

Abstract base class for all Bull-based consumer workers.

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

Hierarchy (View Summary)

BullBaseWorker
- BullAnalyzeWorker
- BullWebhookWorker

Implements

BaseWorker

Constructors

constructor

new BullBaseWorker(
    validator: Validator,
    config: Config,
    logger: Logger,
    connector: ConsumerConnector,
    router: ConsumerRouter,
    queueName: string,
    settings: Partial<ConsumerWorkerSettings>,
): BullBaseWorker
Creates a new worker instance.
Parameters
- validator: Validator
  The validator instance.
- config: Config
  The config instance.
- logger: Logger
  The logger instance.
- connector: ConsumerConnector
  The connector instance.
- router: ConsumerRouter
  The router instance.
- queueName: string
  The name of the queue.
- settings: Partial<ConsumerWorkerSettings>
  The settings object.
Returns BullBaseWorker

Methods

close

close(): Promise<void>

Gracefully closes the worker.

The worker stops processing new jobs and waits for current jobs to complete. This method should be called during application shutdown to ensure all pending jobs are completed and resources are released.

Returns Promise<void>

Throws
LifecycleError If the worker cannot be closed properly.

Implementation of BaseWorker.close

run

run(): Promise<void>

Starts the worker, enabling it to process jobs.

The worker will begin processing jobs from the queue based on its specification. This method should be called during application bootstrap after all processors have been registered with the router.

Returns Promise<void>

Throws
LifecycleError If the worker cannot be started.

Implementation of BaseWorker.run