QueueGetters

getJob(jobId: string): Promise<Job | undefined>

count(): Promise<number>

getJobCounts(...types: JobType[]): Promise<{ [index: string]: number }>

const counts = await queue.getJobCounts('waiting', 'active', 'completed');
// { waiting: 5, active: 2, completed: 100 }

getJobCountByTypes(...types: JobType[]): Promise<number>

getCompletedCount(): Promise<number>

getFailedCount(): Promise<number>

getDelayedCount(): Promise<number>

getActiveCount(): Promise<number>

getWaitingCount(): Promise<number>

getWaitingChildrenCount(): Promise<number>

getPrioritizedCount(): Promise<number>

getCountsPerPriority(priorities: number[]): Promise<{ [index: string]: number }>

const counts = await queue.getCountsPerPriority([0, 1, 2]);
// { '0': 10, '1': 5, '2': 3 }

getJobs(
  types?: JobType[],
  start?: number,
  end?: number,
  asc?: boolean
): Promise<Job[]>

getWaiting(start?: number, end?: number): Promise<Job[]>

getWaitingChildren(start?: number, end?: number): Promise<Job[]>

getActive(start?: number, end?: number): Promise<Job[]>

getDelayed(start?: number, end?: number): Promise<Job[]>

getPrioritized(start?: number, end?: number): Promise<Job[]>

getCompleted(start?: number, end?: number): Promise<Job[]>

getFailed(start?: number, end?: number): Promise<Job[]>

getJobLogs(
  jobId: string,
  start?: number,
  end?: number,
  asc?: boolean
): Promise<{ logs: string[]; count: number }>

getJobState(jobId: string): Promise<JobState | 'unknown'>

getDependencies(
  parentId: string,
  type: 'processed' | 'pending',
  start: number,
  end: number
): Promise<{
  items: { id: string; v?: any; err?: string }[];
  jobs: JobJsonRaw[];
  total: number;
}>

getMeta(): Promise<QueueMeta>

getGlobalConcurrency(): Promise<number | null>

getGlobalRateLimit(): Promise<{ max: number; duration: number } | null>

getRateLimitTtl(maxJobs?: number): Promise<number>

getDeduplicationJobId(id: string): Promise<string | null>

getWorkers(): Promise<Array<{ [index: string]: string }>>

getWorkersCount(): Promise<number>

getMetrics(
  type: 'completed' | 'failed',
  start?: number,
  end?: number
): Promise<Metrics>

exportPrometheusMetrics(
  globalVariables?: Record<string, string>
): Promise<string>

const metrics = await queue.exportPrometheusMetrics({
  service: 'my-service',
  environment: 'production',
});

console.log(metrics);
// # HELP bullmq_job_count Number of jobs in the queue by state
// # TYPE bullmq_job_count gauge
// bullmq_job_count{queue="myQueue", state="waiting", service="my-service", environment="production"} 5