Interface BullMQJobsPort

Escape hatch installed by the BullMQ jobs provider.

interface BullMQJobsPort {
    queue: BullMQQueue;
    queueName: string;
    checkHealth(options?: BullMQJobsHealthOptions): Promise<BullMQJobsHealth>;
}

Index

Properties

queue queueName

Methods

Properties

queue

queue: BullMQQueue

Raw BullMQ queue used by the Beignet job dispatcher.

queueName

queueName: string

Queue name used by the provider.

Methods

checkHealth

checkHealth(options?: BullMQJobsHealthOptions): Promise<BullMQJobsHealth>
Check the queue connection and return selected BullMQ queue counts.

Use this from app-owned health/readiness endpoints when a deployment needs to prove the direct jobs queue is reachable.
Parameters
- Optionaloptions: BullMQJobsHealthOptions
Returns Promise<BullMQJobsHealth>
- Defined in index.ts:174