a queue for resource events
-
create (options, callback)
-
get (id, callback)
-
find (options, callback)
-
all (callback)
-
update (options, callback)
-
updateOrCreate (options, callback)
-
destroy (id, callback)
-
push (id, job, callback)
-
shift (id, callback)
-
unshift (id, job, callback)
-
take (id, callback)
-
extend (id, elems, callback)
-
run (job, callback)
-
process (id, callback)
-
start (id, callback)
-
stop (id, callback)
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
-
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
get queue by id
-
id
-
type : any
-
description : the id of the object
-
required : true
-
-
callback
- type : function
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
gets all instances of queue
-
callback
- type : function
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
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
destroys a queue by id
-
id
-
type : string
-
description : the id of the object
-
required : true
-
-
callback
- type : function
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); } }
-
shift an element off the queue
-
id
- type : any
-
callback
-
type : function
-
default : function (err) { if (err) { queue.emit('error', err); } }
-
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); } }
-
take queue.concurrency
elements off the queue
-
id
- type : any
-
callback
-
type : function
-
default : function (err) { if (err) { queue.emit('error', err); } }
-
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); } }
-
run a job
-
job
-
properties
-
method
-
type : string
-
required : true
-
-
with
-
type : any
-
default
-
-
-
-
callback
- type : function
process elements off the queue
-
id
- type : any
-
callback
-
type : function
-
required : true
-
start processing a queue
-
id
- type : any
-
callback
-
type : function
-
default : function (err) { if (err) { queue.emit('error', err); } }
-
start processing a queue
-
id
- type : any
-
callback
-
type : function
-
default : function (err) { if (err) { queue.emit('error', err); } }
-
README auto-generated with docs