Skip to content

Event.paused

Grant Carthew edited this page Nov 19, 2016 · 2 revisions

Event Details

Subject: Queue

Signature: (queueId, global)

Returns: queueId String

  • The Queue.id for the Queue object which has paused the queue.

Returns: global Boolean

  • A flag to indicate if the pause is global or local.

Example:

const Queue = require('rethinkdb-job-queue')
const q = new Queue()

q.on('paused', (queueId, global) => {
  console.log('Queue pause: ' + queueId)
  console.log('Pause global: ' + global)
})

Description

The paused event is raised when a Queue object is paused by calling the Queue.pause method. Use the global argument to determine if the pause is applying to the entire queue or just the local Queue object.

Main

How It Works

Contributing

API

Queue Methods

Queue Properties

Queue Events

Job Methods

Job Properties

Documentation

Clone this wiki locally