Class ResqueStore

constructor

• new ResqueStore(options?: ResqueStoreOptions): ResqueStore

  Parameters

  • options: ResqueStoreOptions = {}

  Returns ResqueStore

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 node-resque Queue for operations not wrapped here.

  Returns any

enqueue

• enqueue(queue: string, jobData: string | ResqueJobSpec): Promise<null>

  Enqueue a job onto a named queue via queue.enqueue(queue, name, args). node-resque assigns no client-visible job id, so this resolves to null.

  Parameters

  • queue: string
  • jobData: string | ResqueJobSpec

  Returns Promise<null>

process

• process(
      queue: string,
      handler: (...args: any[]) => any,
      opts?: any,
  ): Promise<any>

  Register a Worker on a queue that runs handler for jobs on it. The handler is added to the shared jobs map under the queue name, and one worker is cached per queue name (a repeat process() returns it).

  Parameters

  • queue: string
  • handler: (...args: any[]) => any
  • opts: any = {}

  Returns Promise<any>

getJob

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

  List queued jobs on a named queue (node-resque queue.queued(queue, start, stop)). node-resque has no addressable per-id lookup, so id is interpreted as the 0-based index into the returned list.

  Parameters

  • queue: string
  • id: string | number

  Returns Promise<any>

remove

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

  Remove matching jobs from a queue via queue.del(queue, name, args). id is the registered job name to delete.

  Parameters

  • queue: string
  • id: string

  Returns Promise<any>

stats

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

  Return the number of jobs currently queued on a named queue.

  Parameters

  • queue: string

  Returns Promise<number>