Class BeanstalkdStore

constructor

• new BeanstalkdStore(options?: BeanstalkdStoreOptions): BeanstalkdStore

  Parameters

  • options: BeanstalkdStoreOptions = {}

  Returns BeanstalkdStore

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 fivebeans client for operations not wrapped here.

  Returns any

enqueue

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

  Enqueue a job into a tube. Selects the tube via use(), then put()s the (JSON-serialized) payload with the given priority/delay/ttr. Returns the job id assigned by the server.

  Parameters

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

  Returns Promise<string>

process

• process(
      queue: string,
      handler: (job: BeanstalkdJob) => void | Promise<void>,
  ): Promise<void>

  Register a worker on a tube: watch() it, then loop reserve()ing jobs and invoking handler(job). After the handler resolves the job is destroy()ed. The loop stops when the store disconnects.

  Parameters

  • queue: string
  • handler: (job: BeanstalkdJob) => void | Promise<void>

  Returns Promise<void>

getJob

• getJob(_queue: string, id: string): Promise<BeanstalkdJob | null>

  Peek at a job by id, returning its id and payload (or null if absent).

  Parameters

  • _queue: string
  • id: string

  Returns Promise<BeanstalkdJob | null>

remove

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

  Delete (destroy) a job by id.

  Parameters

  • _queue: string
  • id: string

  Returns Promise<void>

stats

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

  Return per-tube statistics (stats-tube), e.g. ready/reserved/buried counts.

  Parameters

  • queue: string

  Returns Promise<any>