aligning the entire protocol to use options.

Author: vitaly-t

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);
     };
 };

package.json

@@ -10,7 +10,7 @@
     "coverage": "istanbul cover ./node_modules/jasmine-node/bin/jasmine-node test",
     "travis": "npm run lint && istanbul cover ./node_modules/jasmine-node/bin/jasmine-node test --captureExceptions && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage",
     "browserify": "browserify lib/index.js -s spexLib -o spex.js",
-    "lint": "./node_modules/.bin/eslint ./lib"
+    "lint": "./node_modules/.bin/eslint ./lib ./test/**/Spec*.js"
   },
   "files": [
     "lib",

test/es6Spec.js

@@ -1,7 +1,7 @@
 'use strict';
 
 try {
-    eval("(function *(){})");
+    eval('(function *(){})');
 } catch (e) {
     return; // ES6 not supported, exit.
 }
@@ -11,4 +11,3 @@ require('./ext/batch/es6');
 require('./ext/page/es6');
 require('./ext/sequence/es6');
 require('./ext/stream/es6');
-