fix docs + allow read consistency on query.run

stephenplusplus · stephenplusplus · commit acdb279e8ddb · 2016-05-05T15:35:57.000-04:00
diff --git a/lib/datastore/query.js b/lib/datastore/query.js
@@ -307,18 +307,15 @@ Query.prototype.offset = function(n) {
 /**
  * Run the query.
  *
+ * @param {object=} options - Optional configuration.
+ * @param {string} options.consistency - Specify either `strong` or `eventual`.
+ *     If not specified, default values are chosen by Datastore for the
+ *     operation. Learn more about strong and eventual consistency
+ *     [here](https://cloud.google.com/datastore/docs/articles/balancing-strong-and-eventual-consistency-with-google-cloud-datastore).
  * @param {function=} callback - The callback function. If omitted, a readable
  *     stream instance is returned.
  * @param {?error} callback.err - An error returned while making this request
- *     (may be null).
- * @param {array} callback.entities - The list of entities returned by this
- *     query. Note that this is a single page of entities, not necessarily
- *     all of the entities.
- * @param {?module:datastore/query} callback.nextQuery - If present, run another
- *     query with this object to check for more results.
- * @param {object} callback.apiResponse - The full API response.
- * @param {?error} callback.err - An error returned while making this request
- * @param {module:datastore/entity[]} callback.entities - A list of Entities
+ * @param {object[]} callback.entities - A list of entities.
  * @param {?object} callback.nextQuery - If present, query with this object to
  *     check for more results.
  * @param {object} callback.apiResponse - The full API response.
@@ -372,8 +369,11 @@ Query.prototype.offset = function(n) {
  *   // entities[].data = Empty object
  * });
  */
-Query.prototype.run = function(callback) {
-  return this.scope.runQuery(this, callback);
+Query.prototype.run = function() {
+  var query = this;
+  var args = [query].concat([].slice.call(arguments));
+
+  return this.scope.runQuery.apply(this.scope, args);
 };
 
 module.exports = Query;
diff --git a/lib/datastore/request.js b/lib/datastore/request.js
@@ -388,15 +388,7 @@ DatastoreRequest.prototype.insert = function(entities, callback) {
  * @param {function=} callback - The callback function. If omitted, a readable
  *     stream instance is returned.
  * @param {?error} callback.err - An error returned while making this request
- *     (may be null).
- * @param {array} callback.entities - The list of entities returned by this
- *     query. Note that this is a single page of entities, not necessarily
- *     all of the entities.
- * @param {?module:datastore/query} callback.nextQuery - If present, run another
- *     query with this object to check for more results.
- * @param {object} callback.apiResponse - The full API response.
- * @param {?error} callback.err - An error returned while making this request
- * @param {module:datastore/entity[]} callback.entities - A list of Entities
+ * @param {object[]} callback.entities - A list of entities.
  * @param {?object} callback.nextQuery - If present, query with this object to
  *     check for more results.
  * @param {object} callback.apiResponse - The full API response.
diff --git a/test/datastore/query.js b/test/datastore/query.js
@@ -19,7 +19,6 @@
 var assert = require('assert');
 
 var Query = require('../../lib/datastore/query.js');
-var util = require('../../lib/common/util.js');
 
 describe('Query', function() {
   var SCOPE = {};
@@ -321,16 +320,20 @@ describe('Query', function() {
 
   describe('run', function() {
     it('should call the parent instance runQuery correctly', function() {
+      var args = [0, 1, 2];
       var runQueryReturnValue = {};
-      var callback = util.noop;
 
-      query.scope.runQuery = function(query_, callback_) {
-        assert.strictEqual(query_, query);
-        assert.strictEqual(callback_, callback);
+      query.scope.runQuery = function() {
+        assert.strictEqual(this, query.scope);
+        assert.strictEqual(arguments[0], query);
+        assert.strictEqual(arguments[1], args[0]);
+        assert.strictEqual(arguments[2], args[1]);
+        assert.strictEqual(arguments[3], args[2]);
         return runQueryReturnValue;
       };
 
-      assert.strictEqual(query.run(callback), runQueryReturnValue);
+      var results = query.run.apply(query, args);
+      assert.strictEqual(results, runQueryReturnValue);
     });
   });
 });
