Class BullMQStore

constructor

• new BullMQStore(options?: BullMQStoreOptions): BullMQStore

  Parameters

  • options: BullMQStoreOptions = {}

  Returns BullMQStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): any

  Returns the underlying bullmq driver module (with Queue/Worker).

  Returns any

enqueue

• enqueue(
      queue: string,
      jobData: unknown,
      opts?: BullMQEnqueueOptions,
  ): Promise<string>

  Add a job to the named queue via queue.add(name, data, opts). Returns the id BullMQ assigns to the job.

  Parameters

  • queue: string
  • jobData: unknown
  • opts: BullMQEnqueueOptions = {}

  Returns Promise<string>

process

• process(queue: string, handler: (job: any) => any, opts?: any): Promise<any>

  Register a Worker for the named queue that runs handler(job) for each job. One worker is cached per queue name; a second process() on the same name returns the existing worker.

  Parameters

  • queue: string
  • handler: (job: any) => any
  • opts: any = {}

  Returns Promise<any>

getJob

• getJob(queue: string, id: string): Promise<any>

  Fetch a job by id from the named queue (null if it no longer exists).

  Parameters

  • queue: string
  • id: string

  Returns Promise<any>

remove

• remove(queue: string, id: string): Promise<void>

  Remove a job by id from the named queue.

  Parameters

  • queue: string
  • id: string

  Returns Promise<void>

stats

• stats(queue: string): Promise<any>

  Return job counts by state (waiting/active/completed/failed/...).

  Parameters

  • queue: string

  Returns Promise<any>