Socket
Socket
Sign inDemoInstall

queued-up

Package Overview
Dependencies
0
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

npm Scripts

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 1.0.0 to 1.1.0

54

app.js

@@ -1,58 +0,8 @@

var qup = require('./index');
// function action(data) {
// var _self = this;
// console.log(_self.index());
// setTimeout(function(){
// _self.done(_self.queue()[_self.index()]);
// }, 1000);
// };
//### Scenario - Async: Iterate over items with async call
// var q = qup({action: action});
//### Scenario - Async: Iterate over Async functions
// q.add(["obj 0", "obj 1", "obj 2", "obj 3", "obj 4", "obj 5", "obj 6"]);
// q.on('paused', function (data) {
// console.log("paused:" + data);
// });
// q.on('complete', function (data) {
// console.log("complete data: " + data);
// });
// q.run();
// setTimeout(function(){
// q.pause()
// }, 2500);
// setTimeout(function(){
// q.resume()
// }, 5000);
//This funtion will receive each queued item.
function action(queueItem) {
var _self = this; //maintain a reference to 'this'
console.log(_self.index());
//perform a simulated async call
setTimeout(function(){
//This line passes the queue item straight into the results array.
//_self.done() notifies queued-up that this is complete.
_self.done(queueItem);
}, 1000);
};
var q = qup({action: action});
q.add(["obj 0", "obj 1", "obj 2", "obj 3", "obj 4", "obj 5", "obj 6"]);
q.on('complete', function (data) {
console.log("complete data: " + data);
});
q.run();

198

index.js
var events = require('events');
var Queue = function (inputOptions) {
if(typeof inputOptions === "function"){
inputOptions = {action:inputOptions};
}
var Queue = function () {
var self = this,
_runAll = false,
_shiftRun = false,
_shift = false,
_next = false,
_paused = false,
_pausedOn = null,
_count = 1,
_options = inputOptions,

@@ -12,3 +22,3 @@ _queue = [],

_index = 0;
self.options = _options;
self.action = _options.action;

@@ -20,33 +30,68 @@

self.queue = function(input){
self.done = function(data){
if(Array.isArray(input)){
_queue = input;
if(typeof data === "undefined"){
self.emit('taskcomplete',{index: this.index()});
}else{
self.emit('taskcomplete', {index : this.index(),
taskData: data});
}
return _queue;
return data;
};
self.index = function (inputIndex) {
if (typeof (inputIndex) === "number") {
_index = inputIndex;
self.on('taskcomplete', function(data){
_count--;
if(_shift){
if(typeof data.taskData !== "undefined"){
_runResults.push(data.taskData);
}
if(_shiftRun){
if(_queue.length === 0){
_shiftRun = false;
_shift = false;
self.complete();
}else{
_count = 1;
if(!_paused) self.shift();
}
}else if(!_shiftRun && !_paused){
if(_count > 0){
self.shift(_count);
}else{
_shift = false
_count = 1;
}
}
}else if(_next === true){
_index++;
if(typeof data.taskData !== "undefined"){
_runResults[data.index] = data.taskData;
}
if(_index >= _queue.length){
_runAll = false;
_index = 0;
self.complete();
}
if(_runAll){
_next = true;
if(!_paused) self.next();
}else if(!_runAll && !_paused){
if(_count > 0){
self.next(_count);
}else{
_next = false;
_count = 1;
}
}
}
return _index;
};
self.done = function(data){
self.emit('taskdone', {index : this.index(),
taskData: data});
};
self.on('taskdone', function(data){
_index++;
_runResults[data.index] = data.taskData;
if(_index >= _queue.length){
_runAll = false;
_index = 0;
self.runComplete();
}
if(_runAll === true) self.next();
});

@@ -66,18 +111,61 @@

//perform the next iteration in the _queue
self.next = function () {
self.action(_queue[_index]);
self.next = function (count) {
if(typeof count === "number"){
_count = count;
_paused = false;
}else{
_count = 1;
_paused = false;
}
_next = true;
return self.action(_queue[_index]);
};
self.reset = function () {
self.run = function (index) {
if(typeof index === "number"){
_index = index;
}else{
_index = 0;
};
self.run = function (startIndex) {
_index = 0;
}
_runAll = true;
_runResults = [];
self.next();
};
self.shift = function (count){
if(typeof count === "number"){
_count = count;
_paused = false;
}else{
_count = 1;
_paused = false;
}
_shift = true;
return self.action(_queue.shift());
};
self.shiftRun = function(){
_shiftRun = true;
self.shift();
};
self.shiftResults = function(){
return _runResults.shift();
}
self.results = function(){
return _runResults;
}
self.pause = function () {
if(_shift === true){
_pausedOn = 'shift';
}else if(_next === true){
_pausedOn = 'next';
}
_runAll = false;
_shiftRun = false;
_paused = true;
self.emit('paused', _runResults);

@@ -87,12 +175,40 @@ };

self.resume = function () {
console.log("resume called");
self.emit('resumed');
_runAll = true;
self.next();
_paused = false;
if(_shift === true || _pausedOn === 'shift'){
self.emit('resumed');
_shiftRun = true;
_pausedOn = null;
self.shiftRun();
}else if(_next === true || _pausedOn === 'next'){
self.emit('resumed');
_runAll = true;
_pausedOn = null;
self.next();
}
};
self.runComplete = function () {
self.complete = function () {
self.emit('complete', _runResults);
};
self.reset = function () {
_index = 0;
_queue = [];
_runResults = [];
};
self.queue = function(input){
if(Array.isArray(input)){
_queue = input;
}
return _queue;
};
self.index = function (inputIndex) {
if (typeof (inputIndex) === "number") {
_index = inputIndex;
}
return _index;
};
};

@@ -99,0 +215,0 @@ Queue.prototype = new events.EventEmitter;

2

package.json
{
"name": "queued-up",
"version": "1.0.0",
"version": "1.1.0",
"description": "",

@@ -5,0 +5,0 @@ "main": "index.js",

180

README.md

@@ -0,6 +1,15 @@

[![Stories in Ready](https://badge.waffle.io/Johnhhorton/queued-up.svg?label=ready&title=Ready)](http://waffle.io/Johnhhorton/queued-up)
# queued-up
Simple asynchronous task queuing system.
I wanted to build a task system that made sense, was as simple as it could be, and as powerful as it could be.
This queue module can run basic functions over a list of items, or run a series of async calls meant for vastly different things.
You can either save the resultant data, or simply perform each operation without it.
Pardon my dust. Currently working on it.
Pardon my dust. Functionality finished. Working on documenting all features.
## Install
`npm install queued-up`
## Usage

@@ -17,16 +26,34 @@

* .queue() - Seturns the queue array
* .queue(\[,...\]) - Sets queue array to the input
Methods for the queue instance.
* .queue() - Returns the queue array
* .queue(\[,...\]) - Sets queue array to the input replacing existing items
* .add(input) - Adds the input to the end of the queue array
* .remove(number)- removes the queue item at the given index
* .index - returns the current iteration point of the queue
* .index(number) - sets the index manually
* .next() - processes the next item in the queue.
* .reset() - sets the index to 0
* .run() - begins processing queue
* .next() - processes the next item in the queue, and returns result.
* .next(n) - Processes the next n items in the queue. Get results from .results()
* .run() - begins processing queue while maintaining the queue
* .run(index) - begins processing queue at given index
* .pause() - pauses the queue run after current task complete.
* .resume() - resumes the queue run. Do not call this in the 'paused' event!
* .shift() - Processes the first item in the queue, removes it, and returns the results
* .shift(n) - Performs .shift() for the next n items. Get results from .results()
* .shiftRun() - begins processing all items in the queue, removing each, and appending .results();
* .pause() - pauses the run() at current index or shiftRun().
* .resume() - resumes the queue run. Do not call this within the 'paused' eventhandler!
* .reset() - sets index(), queue(), and results() to zero and empty
* .results() - Returns the results array. Index matching run/next, or order of shift/shiftRun
* .shiftResults()- Returns the first item in the results array and removes it.
methods for the action function
* this.done() - notifies the queue that the task is complete.
* this.done(data)- notifies queue that task is complete, and sends data to .results()
* this.index() - returns the index of the current queue item
### Events

@@ -39,3 +66,3 @@

## Examples
### Scenario - next(): Iterate over items with function

@@ -45,31 +72,27 @@ ```javascript

//This funtion will receive each queued item.
function action(queueItem) {
var _self = this; //maintain a reference to 'this'
//This will show the progress through the queue.
console.log(_self.index());
//perform a simulated async call
setTimeout(function(){
//This line passes the queue item straight into the results array.
//_self.done() notifies queued-up that this is complete.
_self.done(queueItem);
}, 1000);
};
/* Define the function called for each iteration.
* End all action functions with this.done() to notify completion.
* Passing this.done() with an argument will add the data to the results array queue.results().
* Running this.done() as the return function will also return the data in .next() and .shift().
*/
function square(item){
return this.done(item*item);
}
//q will be our queue instance.
var q = qup({action: action});
//Pass the action into the module, and a new queue object will be created.
var queue = qup(square);
//adding an array of string objects to the queue.
q.add(["obj 0", "obj 1", "obj 2", "obj 3", "obj 4", "obj 5", "obj 6"]);
//add the items to the queue
queue.add([1,2,3,4,5,6]);
//Event called when the queue run has finished.
q.on('complete', function (data) {
console.log("complete data: " + data);
});
console.log(queue.next()); //returns 1
console.log(queue.next()); //returns 6
console.log(queue.next()); //returns 9
//start the queue processing.
q.run();
//.results() returns the array of results where the index
//matches the queued item.
console.log(queue.results());//returns [ 1, 4, 9 ]
//.queue returns the contents of the queued items.
console.log(queue.queue());//returns [ 1, 2, 3, 4, 5, 6 ]
```

@@ -79,1 +102,90 @@

### Scenario - shift(): Deplete the queue of items while applying the function.
```javascript
var qup = require('./queued-up');
/* Define the function called for each iteration.
* End all action functions with this.done() to notify completion.
* Passing this.done() with an argument will add the data to the results array queue.results().
* Running this.done() as the return function will also return the data in .next() and .shift().
*/
function square(item){
return this.done(item*item);
}
//Pass the action into the module, and a new queue object will be created.
var queue = qup(square);
//add the items to the queue
queue.add([1,2,3,4,5,6]);
console.log(queue.shift()); //returns 1
console.log(queue.shift()); //returns 6
console.log(queue.shift()); //returns 9
//.results() after a shift() returns the items in the order they were operated on.
console.log(queue.results());//returns [ 1, 4, 9 ]
//.queue after shift shows the remaining items.
console.log(queue.queue());//returns [ 4, 5, 6 ]
```
### Scenario - run(): complete the queued items while maintaining the queue.
```javascript
var qup = require('./queued-up');
function square(item){
return this.done(item*item);
}
var queue = qup(square);
//add the items to the queue
queue.add([1,2,3,4,5,6]);
//Run will run the action function for all items.
queue.run();
console.log(queue.results());//returns [ 1, 4, 9, 16, 25, 36 ]
console.log(queue.queue());//returns [ 1, 2, 3, 4, 5, 6 ]
```
### Scenario - shiftRun(): complete the queued items and deplete the queue.
```javascript
var qup = require('./queued-up');
function square(item){
return this.done(item*item);
}
var queue = qup(square);
//add the items to the queue
queue.add([1,2,3,4,5,6]);
//Run will run the action function for all items.
queue.shiftRun();
console.log(queue.results()); //returns [ 1, 4, 9, 16, 25, 36 ]
console.log(queue.queue()); //returns []
```
### Scenario - next(3) & shift(3): Process a set number of items in the queue.
Note that this would only return the last item. See `.results()` for the results of the processing. This can be useful if you wish to process items in chunks.
```javascript
//will process the next 3 items in the queue.
queue.next(3);
//will process and remove the next 3 items.
queue.shift(3);
```
async examples and usage of the event system will be up soon. Please create
an issue if you run into any problems, or would like to see something done
differently.
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc