in-parallel - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

index.js

@@ -7,3 +7,3 @@ module.exports = {
 		}
-	}
+	},
 	run: function(collection, parallelAction, onFinish, handleError){
@@ -38,3 +38,5 @@ if(collection && isFunction(parallelAction) && isFunction(onFinish)) {
 			} else {
-				if(showDebugMessages) console.log("Provided collection is empty.", true);
+				if(showDebugMessages) {
+					console.log("Provided collection is empty.", true);
+				}
 				if(isFunction(handleError)) {
@@ -41,0 +43,0 @@ //an error handler was provided. handle the error as desired.

package.json

 {
   "name": "in-parallel",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "A small library for Runs a function on the elements of the provided collection in parallel ",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # in-parallel
 A node module for running async tasks on an array and finishing together to run a final function.
+
+## Installation
+
+  npm install in-parallel --save
+
+## Usage
+Initialize inParallel like so:
+  ```javascript
+	//the proceedAfterParallelAction() method is provided
+	var inParallel = require('scapegoat');
+  ```
+###A Simple Example
+  ```javascript
+	var collection = [1,2,3];
+	inParallel.run(collection, function(element){
+		element++;
+		this.proceedAfterParallelAction();
+	}, function(){
+		collection.push(5);
+	});
+  ```
+###A Less Simple Example With MongoDB Queries
+Imagine you have a bunch of users and each user has a bunch of photos all stored in a mongodb. If you have to get each user's photo and do something with them, it'd probably be best to run such tasks in parallel:
+  ```javascript
+  	//a less simple use case with a MongoDB query
+  	var users = [user1,user2,user3];
+  	inParallel.run(users, function(user){
+		//find the user's photos
+		db.collection(PHOTOS_COLLECTION).findOne(searchQuery,function(err, doc) {
+			if(err || !doc) {
+			    	//handle the error
+			    	if(err) console.log("Failed to find one doc: " + err.message);
+		    		//call the provided proceed method after this user is done 
+			   	this.proceedAfterInParallelAction();
+			} else {
+				//find succeeded
+				//do something with the result
+				
+				//call the provided proceed method after this user is done 
+			  	this.proceedAfterInParallelAction();
+			}
+		});
+	}, function(){
+		//everything is done
+		//do something afterwards
+		console.log("FINISHED!");
+	}, function(err){
+		//error. handle it
+		console.log(err.message)
+	});
+```
+
+## Config
+
+###Debug Messages
+  Debug messages are printed to the console by default but you can choose not have that like so:
+  ```javascript
+  	inParallel.config({showDebugMessages:false});
+  ```
+
+  
+
+## Tests
+
+  npm test
+
+## Contributing
+
+In lieu of a formal styleguide, take care to maintain the existing coding style.
+Add unit tests for any new or changed functionality. Lint and test your code.
+
+## Release History
+
+* 0.1.0 Initial release
+
+##Credits
+I used this article to learn how to publish npm articles:
+https://quickleft.com/blog/creating-and-publishing-a-node-js-module/

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5857

increased by82.18%

Number of package files

6

increased by20%

Lines of code

64

increased by3.23%

Number of lines in readme file

81

increased by2600%

No dependency changes