Interface BullMQJobWorkerHandle

BullMQ worker wrapper returned by createBullMQJobWorker(...).

interface BullMQJobWorkerHandle {
    worker: BullMQWorker;
    checkHealth(
        options?: BullMQJobWorkerHealthOptions,
    ): Promise<BullMQJobWorkerHealth>;
    close(options?: BullMQJobWorkerCloseOptions): Promise<void>;
}

Index

Properties

Methods

checkHealth close

Properties

worker

worker: BullMQWorker

Raw BullMQ worker.

Methods

checkHealth

checkHealth(
options?: BullMQJobWorkerHealthOptions,
): Promise<BullMQJobWorkerHealth>
Check that the worker is connected, running, and not paused.
Parameters
- Optionaloptions: BullMQJobWorkerHealthOptions
Returns Promise<BullMQJobWorkerHealth>
- Defined in index.ts:459

close

close(options?: BullMQJobWorkerCloseOptions): Promise<void>
Gracefully close the worker. BullMQ stops claiming new jobs and waits for active jobs to finish.
Parameters
- Optionaloptions: BullMQJobWorkerCloseOptions
Returns Promise<void>
- Defined in index.ts:466