UNPKG

@bull-board/api

Version:

A Dashboard server API built on top of bull or bullmq.

30 lines (29 loc) 1.47 kB
import { Job, Queue } from 'bullmq'; import { JobCleanStatus, JobCounts, JobStatus, MetricsType, QueueAdapterOptions, QueueDefaultJobOptions, QueueJobOptions, QueueMetrics, Status } from '../../typings/app'; import { BaseAdapter } from './base'; export declare class BullMQAdapter extends BaseAdapter { private queue; constructor(queue: Queue, options?: Partial<QueueAdapterOptions>); getRedisInfo(): Promise<string>; getName(): string; clean(jobStatus: JobCleanStatus, graceTimeMs: number): Promise<void>; addJob(name: string, data: any, options: QueueJobOptions): Promise<Job<any, any, string>>; getJob(id: string): Promise<Job | undefined>; getJobs(jobStatuses: JobStatus[], start?: number, end?: number): Promise<Job[]>; getJobCounts(): Promise<JobCounts>; getJobLogs(id: string): Promise<string[]>; getMetrics(type: MetricsType, start?: number, end?: number): Promise<QueueMetrics>; isPaused(): Promise<boolean>; pause(): Promise<void>; resume(): Promise<void>; empty(): Promise<void>; obliterate(): Promise<void>; promoteAll(): Promise<void>; removeJobScheduler(id: string): Promise<boolean>; getStatuses(): Status[]; getJobStatuses(): JobStatus[]; getClient(): Promise<import("bullmq").IRedisClient>; getGlobalConcurrency(): Promise<number | null>; getQueueDefaultJobOptions(): QueueDefaultJobOptions; setGlobalConcurrency(concurrency: number): Promise<void>; }