Class BeeQueueStore

constructor

• new BeeQueueStore(options?: BeeQueueStoreOptions): BeeQueueStore

  Parameters

  • options: BeeQueueStoreOptions = {}

  Returns BeeQueueStore

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 bee-queue Queue constructor.

  Returns any

enqueue

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

  Build a job with queue.createJob(data), apply any retry/delay/timeout options, .save() it, and return the id Bee-Queue assigns.

  Parameters

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

  Returns Promise<string>

process

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

  Register the worker handler for a queue via queue.process(concurrency, handler). Bee-Queue allows only one process() per Queue object, so a repeat call on the same queue name is a no-op.

  Parameters

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

  Returns Promise<any>

getJob

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

  Fetch a job by id from the named queue (queue.getJob(id)).

  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. Uses queue.removeJob(id) when available, otherwise fetches the job and calls job.remove().

  Parameters

  • queue: string
  • id: string

  Returns Promise<void>

stats

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

  Return job counts by state for a queue. Uses queue.getJobCounts() when available, otherwise falls back to Bee-Queue's queue.checkHealth().

  Parameters

  • queue: string

  Returns Promise<any>