resource-queue

a queue for resource events

npm install resource-queue
2 downloads in the last week
8 downloads in the last month

queue

a queue for resource events

API

properties

methods

properties

a queue for resource events

  • id

    • type : any
  • concurrency

    • description : how many jobs to run at once

    • type : number

    • default : 1

  • interval

    • description : time interval between processing items (ms)

    • type : number

    • default : 5000

  • wait

    • description : wait until all running jobs are completed before executing next set

    • type : boolean

    • default : true

  • repeat

    • description : automatically push completed elements back onto the queue

    • type : boolean

    • default : false

  • elements

    • description : the elements currently inside the queue

    • type : array

    • default

  • started

    • description : whether or not the queue has been started

    • type : boolean

    • default : false

  • inProgress

    • description : the elements currently being processed

    • type : array

    • default

methods

queue.create(options, callback)

create a new queue

  • options

    • type : object

    • properties

      • id

        • type : any
      • concurrency

        • description : how many jobs to run at once

        • type : number

        • default : 1

      • interval

        • description : time interval between processing items (ms)

        • type : number

        • default : 5000

      • wait

        • description : wait until all running jobs are completed before executing next set

        • type : boolean

        • default : true

      • repeat

        • description : automatically push completed elements back onto the queue

        • type : boolean

        • default : false

      • elements

        • description : the elements currently inside the queue

        • type : array

        • default

      • started

        • description : whether or not the queue has been started

        • type : boolean

        • default : false

      • inProgress

        • description : the elements currently being processed

        • type : array

        • default

  • callback

    • type : function

queue.get(id, callback)

get queue by id

  • id

    • type : any

    • description : the id of the object

    • required : true

  • callback

    • type : function

queue.find(options, callback)

search for instances of queue

  • options

    • type : object

    • properties

      • id

        • type : any

        • default :

        • required : false

      • concurrency

        • description : how many jobs to run at once

        • type : any

        • default :

        • required : false

      • interval

        • description : time interval between processing items (ms)

        • type : any

        • default :

        • required : false

      • wait

        • description : wait until all running jobs are completed before executing next set

        • type : any

        • default :

        • required : false

      • repeat

        • description : automatically push completed elements back onto the queue

        • type : any

        • default :

        • required : false

      • elements

        • description : the elements currently inside the queue

        • type : any

        • default :

        • required : false

      • started

        • description : whether or not the queue has been started

        • type : any

        • default :

        • required : false

      • inProgress

        • description : the elements currently being processed

        • type : any

        • default :

        • required : false

  • callback

    • type : function

queue.all(callback)

gets all instances of queue

  • callback

    • type : function

queue.update(options, callback)

updates a queue by id

  • options

    • type : object

    • properties

      • id

        • type : any
      • concurrency

        • description : how many jobs to run at once

        • type : number

        • default : 1

      • interval

        • description : time interval between processing items (ms)

        • type : number

        • default : 5000

      • wait

        • description : wait until all running jobs are completed before executing next set

        • type : boolean

        • default : true

      • repeat

        • description : automatically push completed elements back onto the queue

        • type : boolean

        • default : false

      • elements

        • description : the elements currently inside the queue

        • type : array

        • default

      • started

        • description : whether or not the queue has been started

        • type : boolean

        • default : false

      • inProgress

        • description : the elements currently being processed

        • type : array

        • default

  • callback

    • type : function

queue.updateOrCreate(options, callback)

updates a queue by id, and creates if necessary

  • options

    • type : object

    • properties

      • id

        • type : any
      • concurrency

        • description : how many jobs to run at once

        • type : number

        • default : 1

      • interval

        • description : time interval between processing items (ms)

        • type : number

        • default : 5000

      • wait

        • description : wait until all running jobs are completed before executing next set

        • type : boolean

        • default : true

      • repeat

        • description : automatically push completed elements back onto the queue

        • type : boolean

        • default : false

      • elements

        • description : the elements currently inside the queue

        • type : array

        • default

      • started

        • description : whether or not the queue has been started

        • type : boolean

        • default : false

      • inProgress

        • description : the elements currently being processed

        • type : array

        • default

  • callback

    • type : function

queue.destroy(id, callback)

destroys a queue by id

  • id

    • type : string

    • description : the id of the object

    • required : true

  • callback

    • type : function

queue.push(id, job, callback)

push an element onto the queue

  • id

    • type : any
  • job

    • properties

      • method

        • type : string
      • with

        • type : any

        • default

  • callback

    • type : function

    • default : function (err, _queue) {

      if (err) {
        queue.emit('error', err, _queue);
      }
      

      }

queue.shift(id, callback)

shift an element off the queue

  • id

    • type : any
  • callback

    • type : function

    • default : function (err) {

      if (err) {
        queue.emit('error', err);
      }
      

      }

queue.unshift(id, job, callback)

unshift an element onto the front of the queue

  • id

    • type : any
  • job

    • properties

      • method

        • type : string
      • with

        • type : any

        • default

  • callback

    • type : function

    • default : function (err) {

      if (err) {
        queue.emit('error', err);
      }
      

      }

queue.take(id, callback)

take queue.concurrency elements off the queue

  • id

    • type : any
  • callback

    • type : function

    • default : function (err) {

      if (err) {
        queue.emit('error', err);
      }
      

      }

queue.extend(id, elems, callback)

extend the queue with an array of elements

  • id

    • type : any
  • elems

    • type : any
  • callback

    • type : function

    • default : function (err) {

      if (err) {
        queue.emit('error', err);
      }
      

      }

queue.run(job, callback)

run a job

  • job

    • properties

      • method

        • type : string

        • required : true

      • with

        • type : any

        • default

  • callback

    • type : function

queue.process(id, callback)

process elements off the queue

  • id

    • type : any
  • callback

    • type : function

    • required : true

queue.start(id, callback)

start processing a queue

  • id

    • type : any
  • callback

    • type : function

    • default : function (err) {

      if (err) {
        queue.emit('error', err);
      }
      

      }

queue.stop(id, callback)

start processing a queue

  • id

    • type : any
  • callback

    • type : function

    • default : function (err) {

      if (err) {
        queue.emit('error', err);
      }
      

      }

README auto-generated with docs

npm loves you