Queue.idle

Property Details

Usage: Read Only

Get: Boolean

• Returns true or false depending on if the Queue object is idle or not.

Example:

const Queue = require('rethinkdb-job-queue')
const q = new Queue()
let isIdle = q.idle
// isIdle === true

Description

This is a convenience method on top of Queue.running. By getting the Queue.idle property the Queue.running jobs value is checked and if running is equal to zero a true value is returned. Anything other than zero and the Queue object is not in an idle state.