- 
                Notifications
    
You must be signed in to change notification settings  - Fork 16
 
Queue.summary
        Grant Carthew edited this page Aug 18, 2016 
        ·
        5 revisions
      
    Returns: Promise => Object
- Object containing 7 properties related to job status.
 
Example:
q.summary().then((summary) => {
  console.dir(summary)
}).catch((err) => {
  console.error(err)
})This is a simple queue summary of job status numbers stored in the queue backing table. The resulting object will look like this:
{ added: 11,
  active: 30,
  completed: 9721,
  cancelled: 4,
  failed: 1,
  terminated: 0,
  total: 9767 }Use Queue.summary at any time to inspect your queue.
As above, this is a simple summary example.
q.summary().then((summary) => {
  console.dir(summary)
}).catch((err) => {
  console.error(err)
})- Introduction
 - Tutorial
 - Queue Constructor
 - Queue Connection
 - Queue Options
 - Queue PubSub
 - Queue Master
 - Queue Events
 - State Document
 - Job Processing
 - Job Options
 - Job Status
 - Job Retry
 - Job Repeat
 - Job Logging
 - Job Editing
 - Job Schema
 - Job Name
 - Complex Job
 - Delayed Job
 - Cancel Job
 - Error Handling
 
- Queue.createJob
 - Queue.addJob
 - Queue.getJob
 - Queue.findJob
 - Queue.findJobByName
 - Queue.containsJobByName
 - Queue.cancelJob
 - Queue.reanimateJob
 - Queue.removeJob
 - Queue.process
 - Queue.review
 - Queue.summary
 - Queue.ready
 - Queue.pause
 - Queue.resume
 - Queue.reset
 - Queue.stop
 - Queue.drop
 - Queue.Job
 
- Queue.host
 - Queue.port
 - Queue.db
 - Queue.name
 - Queue.r
 - Queue.id
 - Queue.jobOptions [R/W]
 - Queue.changeFeed
 - Queue.master
 - Queue.masterInterval
 - Queue.removeFinishedJobs
 - Queue.running
 - Queue.concurrency [R/W]
 - Queue.paused
 - Queue.idle
 
- Event.ready
 - Event.added
 - Event.updated
 - Event.active
 - Event.processing
 - Event.progress
 - Event.log
 - Event.pausing
 - Event.paused
 - Event.resumed
 - Event.completed
 - Event.cancelled
 - Event.failed
 - Event.terminated
 - Event.reanimated
 - Event.removed
 - Event.idle
 - Event.reset
 - Event.error
 - Event.reviewed
 - Event.detached
 - Event.stopping
 - Event.stopped
 - Event.dropped
 
- Job.setName
 - Job.setPriority
 - Job.setTimeout
 - Job.setDateEnable
 - Job.setRetryMax
 - Job.setRetryDelay
 - Job.setRepeat
 - Job.setRepeatDelay
 - Job.updateProgress
 - Job.update
 - Job.getCleanCopy
 - Job.addLog
 - Job.getLastLog