main - npm Package Compare versions

Comparing version 0.0.17 to 0.0.18

examples/stdin.js

 #!/usr/bin/env node
 
 require('../index')(module).run(function($) {
+
+	// CALLBACK based
+
     $.stdin(function(input) { // read from standard input
     	$.out(input); // write to standard output (process.stdout.write)
      });
+
+    // PROMISE based
+    var stdin = $.stdin();
+    stdin.then(function(input) {
+    	$.out(input);
+    });
 });

package.json

 {
   "name": "main",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "main": "index.js",
+  "description": "Provides useful tools for writing command line scripts",
   "repository": {
@@ -14,3 +15,4 @@ "type": "git",
     "optimist": "~0.6.0",
-    "temp": "~0.6.0"
+    "temp": "~0.6.0",
+    "when": "~2.5.1"
   },
@@ -17,0 +19,0 @@ "author": "Trevor Senior <[e-mail]> (http://tsenior.com/)",

README.md

@@ -83,3 +83,3 @@ node-main
 
-##### `$.stdin(callback)`
+##### `$.stdin(callback)` or `$.stdin()` (promise based)
 
@@ -89,4 +89,6 @@ Read from stdin in it's entirety, and return a string once finished in a callback. Do not use this if you are dealing with large amounts of data from stdin - look towards streaming solutions.
 ```javascript
-// read from stdin, write to stdout
+// read from stdin, write to stdout (callback based)
 $.stdin(function(input) { $.out(input); });
+// same thing with promises
+$.stdin().then(function(input) { $.out(input); })
 ```
@@ -93,0 +95,0 @@

src/Tools.js

@@ -67,2 +67,5 @@ var extend = require('util')._extend;
 	self.stdin = function(callback) {
+		if (typeof callback === 'undefined') {
+			var defer = require('when').defer();
+		}
 		var stdinStr = '';
@@ -72,3 +75,8 @@ process.stdin.resume();
 		process.stdin.on('data', function(chunk) { stdinStr += chunk; });
-		process.stdin.on('end', function() { callback(stdinStr); });
+		process.stdin.on('end', function() {
+			return (typeof callback === 'function')
+				? callback(stdinStr) : defer.resolve(stdinStr);
+		});
+
+		if (defer) { return defer.promise; }
 	};
@@ -75,0 +83,0 @@

No alert changes

Improved metrics

Total package byte prevSize

23518

increased by2.42%

Lines of code

373

increased by3.61%

Number of lines in readme file

307

increased by0.66%

Worsened metrics

Dependency count

3

increased by50%

Dependency changes

• + Addedwhen@~2.5.1

• + Addedwhen@2.5.1(transitive)