Queue.summary

Method Signature

Queue.summary()

Returns: Promise => Object

• Object containing 7 properties related to job status.

Example:

q.summary().then((summary) => {
  console.dir(summary)
}).catch(err => console.error(err))

Description

This is a simple queue summary of job status numbers stored in the queue backing table. The resulting object will look like this:

{ waiting: 11,
  active: 30,
  completed: 9721,
  cancelled: 4,
  failed: 1,
  terminated: 0,
  total: 9767 }

See the Job Status document to understand more about these status names.

Use Queue.summary at any time to inspect your queue.

Example

As above, this is a simple summary example.

q.summary().then((summary) => {
  console.dir(summary)
}).catch(err => console.error(err))