Merge pull request #11 from vitaly-t/stream-read

Stream read

Author: vitaly-t

.eslintrc.json

@@ -5,8 +5,6 @@
     "jasmine": true
   },
   "extends": "eslint:recommended",
-  "parserOptions": {
-  },
   "rules": {
     "no-else-return": "error",
     "no-multi-spaces": "error",
@@ -15,6 +13,13 @@
     "new-cap": "error",
     "no-console": "error",
     "comma-dangle": "error",
+    "indent": [
+      "error",
+      4,
+      {
+        "SwitchCase": 1
+      }
+    ],
     "quotes": [
       "error",
       "single"

README.md

@@ -69,7 +69,7 @@ $ npm run coverage
 
 ## License
 
-Copyright © 2016 [Vitaly Tomilov](https://github.com/vitaly-t);
+Copyright © 2017 [Vitaly Tomilov](https://github.com/vitaly-t);
 Released under the MIT license.
 
 

lib/ext/batch.js

@@ -5,9 +5,6 @@ var BatchError = require('../errors/batch');
 /**
  * @method batch
  * @description
- * **Alternative Syntax:**
- * `batch(values, {cb})` ⇒ `Promise`
- *
  * Settles (resolves or rejects) every [mixed value]{@tutorial mixed} in the input array.
  *
  * The method resolves with an array of results, the same as the standard $[promise.all],
@@ -20,7 +17,10 @@ var BatchError = require('../errors/batch');
  * Passing in anything other than an array will reject with {@link external:TypeError TypeError} =
  * `Method 'batch' requires an array of values.`
  *
- * @param {Function|generator} [cb]
+ * @param {Object} [options]
+ * Optional Parameters.
+ *
+ * @param {Function|generator} [options.cb]
  * Optional callback (or generator) to receive the result for each settled value.
  *
  * Callback Parameters:
@@ -53,7 +53,7 @@ var BatchError = require('../errors/batch');
  *  - notification callback `cb` returned a rejected promise or threw an error
  *
  */
-function batch(values, cb, config) {
+function batch(values, options, config) {
 
     var $p = config.promise, $utils = config.utils;
 
@@ -67,8 +67,11 @@ function batch(values, cb, config) {
         return $p.resolve(empty);
     }
 
-    cb = $utils.wrap(cb);
-    var self = this, start = Date.now();
+    options = options || {};
+
+    var cb = $utils.wrap(options.cb),
+        self = this, start = Date.now();
+
     return $p(function (resolve, reject) {
         var cbTime, errors = [], remaining = values.length,
             result = new Array(remaining);
@@ -143,10 +146,7 @@ function batch(values, cb, config) {
 }
 
 module.exports = function (config) {
-    return function (values, cb) {
-        if (cb && typeof cb === 'object') {
-            return batch.call(this, values, cb.cb, config);
-        }
-        return batch.call(this, values, cb, config);
+    return function (values, options) {
+        return batch.call(this, values, options, config);
     };
 };

lib/ext/page.js

@@ -5,9 +5,6 @@ var PageError = require('../errors/page');
 /**
  * @method page
  * @description
- * **Alternative Syntax:**
- * `page(source, {dest, limit})` ⇒ `Promise`
- *
  * Resolves a dynamic sequence of pages/arrays with [mixed values]{@tutorial mixed}.
  *
  * The method acquires pages (arrays of [mixed values]{@tutorial mixed}) from the `source` function, one by one,
@@ -33,7 +30,10 @@ var PageError = require('../errors/page');
  *
  * Passing in anything other than a function will reject with {@link external:TypeError TypeError} = `Parameter 'source' must be a function.`
  *
- * @param {Function|generator} [dest]
+ * @param {Object} [options]
+ * Optional Parameters.
+ *
+ * @param {Function|generator} [options.dest]
  * Optional destination function (or generator), to receive a resolved {@link batch} of data
  * for each page, process it and respond as required.
  *
@@ -51,7 +51,7 @@ var PageError = require('../errors/page');
  * If the function throws an error or returns a rejected promise, the sequence terminates,
  * and the method rejects with {@link errors.PageError PageError}, which will have property `dest` set.
  *
- * @param {Number} [limit=0]
+ * @param {Number} [options.limit=0]
  * Limits the maximum number of pages to be requested from the `source`. If the value is greater
  * than 0, the method will successfully resolve once the specified limit has been reached.
  *
@@ -70,19 +70,21 @@ var PageError = require('../errors/page');
  * When the method fails, it rejects with {@link errors.PageError PageError}.
  *
  */
-function page(source, dest, limit, config) {
+function page(source, options, config) {
 
     var $p = config.promise, $spex = config.spex, $utils = config.utils;
 
     if (typeof source !== 'function') {
         return $p.reject(new TypeError('Parameter \'source\' must be a function.'));
     }
 
-    limit = (limit > 0) ? parseInt(limit) : 0;
+    options = options || {};
     source = $utils.wrap(source);
-    dest = $utils.wrap(dest);
 
-    var self = this, request, srcTime, destTime, start = Date.now(), total = 0;
+    var request, srcTime, destTime,
+        limit = (options.limit > 0) ? parseInt(options.limit) : 0,
+        dest = $utils.wrap(options.dest),
+        self = this, start = Date.now(), total = 0;
 
     return $p(function (resolve, reject) {
 
@@ -176,10 +178,7 @@ function page(source, dest, limit, config) {
 }
 
 module.exports = function (config) {
-    return function (source, dest, limit) {
-        if (dest && typeof dest === 'object') {
-            return page.call(this, source, dest.dest, dest.limit, config);
-        }
-        return page.call(this, source, dest, limit, config);
+    return function (source, options) {
+        return page.call(this, source, options, config);
     };
 };

lib/ext/sequence.js

@@ -5,9 +5,6 @@ var SequenceError = require('../errors/sequence');
 /**
  * @method sequence
  * @description
- * **Alternative Syntax:**
- * `sequence(source, {dest, limit, track})` ⇒ `Promise`
- *
  * Resolves a dynamic sequence of [mixed values]{@tutorial mixed}.
  *
  * The method acquires [mixed values]{@tutorial mixed} from the `source` function, one at a time, and resolves them,
@@ -31,7 +28,10 @@ var SequenceError = require('../errors/sequence');
  *
  * Passing in anything other than a function will reject with {@link external:TypeError TypeError} = `Parameter 'source' must be a function.`
  *
- * @param {Function|generator} [dest]
+ * @param {Object} [options]
+ * Optional Parameters.
+ *
+ * @param {Function|generator} [options.dest=null]
  * Optional destination function (or generator), to receive resolved data for each index,
  * process it and respond as required.
  *
@@ -49,7 +49,7 @@ var SequenceError = require('../errors/sequence');
  * If the function throws an error or returns a rejected promise, the sequence terminates,
  * and the method rejects with {@link errors.SequenceError SequenceError}, which will have property `dest` set.
  *
- * @param {Number} [limit=0]
+ * @param {Number} [options.limit=0]
  * Limits the maximum size of the sequence. If the value is greater than 0, the method will
  * successfully resolve once the specified limit has been reached.
  *
@@ -58,7 +58,7 @@ var SequenceError = require('../errors/sequence');
  *  - `source` either returns or resolves with `undefined`
  *  - either `source` or `dest` functions throw an error or return a rejected promise
  *
- * @param {Boolean} [track=false]
+ * @param {Boolean} [options.track=false]
  * Changes the type of data to be resolved by this method. By default, it is `false`
  * (see the return result). When set to be `true`, the method tracks/collects all resolved data
  * into an array internally, and resolves with that array once the method has finished successfully.
@@ -79,19 +79,21 @@ var SequenceError = require('../errors/sequence');
  *
  * When the method fails, it rejects with {@link errors.SequenceError SequenceError}.
  */
-function sequence(source, dest, limit, track, config) {
+function sequence(source, options, config) {
 
     var $p = config.promise, $utils = config.utils;
 
     if (typeof source !== 'function') {
         return $p.reject(new TypeError('Parameter \'source\' must be a function.'));
     }
 
-    limit = (limit > 0) ? parseInt(limit) : 0;
     source = $utils.wrap(source);
-    dest = $utils.wrap(dest);
 
-    var self = this, data, srcTime, destTime, result = [], start = Date.now();
+    options = options || {};
+
+    var limit = (options.limit > 0) ? parseInt(options.limit) : 0,
+        dest = $utils.wrap(options.dest),
+        self = this, data, srcTime, destTime, result = [], start = Date.now();
 
     return $p(function (resolve, reject) {
 
@@ -104,7 +106,7 @@ function sequence(source, dest, limit, track, config) {
                 if (data === undefined) {
                     success();
                 } else {
-                    if (track) {
+                    if (options.track) {
                         result.push(data);
                     }
                     if (dest) {
@@ -164,7 +166,7 @@ function sequence(source, dest, limit, track, config) {
 
             function success() {
                 var length = Date.now() - start;
-                if (track) {
+                if (options.track) {
                     $utils.extend(result, 'duration', length);
                 } else {
                     result = {
@@ -186,10 +188,7 @@ function sequence(source, dest, limit, track, config) {
 }
 
 module.exports = function (config) {
-    return function (source, dest, limit, track) {
-        if (dest && typeof dest === 'object') {
-            return sequence.call(this, source, dest.dest, dest.limit, dest.track, config);
-        }
-        return sequence.call(this, source, dest, limit, track, config);
+    return function (source, options) {
+        return sequence.call(this, source, options, config);
     };
 };

lib/ext/stream/index.js

@@ -65,4 +65,3 @@ module.exports = function (config) {
     Object.freeze(res);
     return res;
 };
-