mongodb 2.1.0-alpha → 2.1.2

package/lib/admin.js

@@ -1,11 +1,13 @@
 "use strict";
 
-var toError = require('./utils').toError;
+var toError = require('./utils').toError,
+  Define = require('./metadata'),
+  shallowClone = require('./utils').shallowClone;
 
 /**
  * @fileOverview The **Admin** class is an internal class that allows convenient access to
  * the admin functionality and commands for MongoDB.
- * 
+ *
  * **ADMIN Cannot directly be instantiated**
  * @example
  * var MongoClient = require('mongodb').MongoClient,
@@ -16,7 +18,7 @@ var toError = require('./utils').toError;
  * MongoClient.connect(url, function(err, db) {
  *   // Use the admin database for the operation
  *   var adminDb = db.admin();
- *     
+ *
  *   // List all the available databases
  *   adminDb.listDatabases(function(err, dbs) {
  *     test.equal(null, err);
@@ -43,6 +45,8 @@ var Admin = function(db, topology, promiseLibrary) {
   }
 }
 
+var define = Admin.define = new Define('Admin', Admin, false);
+
 /**
  * The callback format for results
  * @callback Admin~resultCallback
@@ -57,7 +61,7 @@ var Admin = function(db, topology, promiseLibrary) {
  * @param {object} [options=null] Optional settings.
  * @param {(ReadPreference|string)} [options.readPreference=null] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
  * @param {number} [options.maxTimeMS=null] Number of milliseconds to wait before aborting the query.
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.command = function(command, options, callback) {
@@ -79,14 +83,15 @@ Admin.prototype.command = function(command, options, callback) {
       resolve(doc);
     });
   });
+}
 
-} 
+define.classMethod('command', {callback: true, promise:true});
 
 /**
  * Retrieve the server information for the current
  * instance of the db client
  *
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.buildInfo = function(callback) {
@@ -98,16 +103,18 @@ Admin.prototype.buildInfo = function(callback) {
   return new this.s.promiseLibrary(function(resolve, reject) {
     self.serverInfo(function(err, r) {
       if(err) return reject(err);
-      resolve(r); 
+      resolve(r);
     });
   });
 }
 
+define.classMethod('buildInfo', {callback: true, promise:true});
+
 /**
  * Retrieve the server information for the current
  * instance of the db client
  *
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.serverInfo = function(callback) {
@@ -127,10 +134,12 @@ Admin.prototype.serverInfo = function(callback) {
   });
 }
 
+define.classMethod('serverInfo', {callback: true, promise:true});
+
 /**
  * Retrieve this db's server status.
  *
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.serverStatus = function(callback) {
@@ -143,7 +152,7 @@ Admin.prototype.serverStatus = function(callback) {
   return new this.s.promiseLibrary(function(resolve, reject) {
     serverStatus(self, function(err, r) {
       if(err) return reject(err);
-      resolve(r); 
+      resolve(r);
     });
   });
 };
@@ -156,13 +165,15 @@ var serverStatus = function(self, callback) {
       if(err) return callback(err, false);
       return callback(toError(doc), false);
     }
-  });  
+  });
 }
 
+define.classMethod('serverStatus', {callback: true, promise:true});
+
 /**
  * Retrieve the current profiling Level for MongoDB
  *
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.profilingLevel = function(callback) {
@@ -175,7 +186,7 @@ Admin.prototype.profilingLevel = function(callback) {
   return new this.s.promiseLibrary(function(resolve, reject) {
     profilingLevel(self, function(err, r) {
       if(err) return reject(err);
-      resolve(r); 
+      resolve(r);
     });
   });
 };
@@ -196,10 +207,12 @@ var profilingLevel = function(self, callback) {
   });
 }
 
+define.classMethod('profilingLevel', {callback: true, promise:true});
+
 /**
  * Ping the MongoDB server and retrieve results
  *
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.ping = function(options, callback) {
@@ -215,37 +228,45 @@ Admin.prototype.ping = function(options, callback) {
   return new this.s.promiseLibrary(function(resolve, reject) {
     self.s.db.executeDbAdminCommand({ping: 1}, function(err, r) {
       if(err) return reject(err);
-      resolve(r); 
+      resolve(r);
     });
   });
 }
 
+define.classMethod('ping', {callback: true, promise:true});
+
 /**
  * Authenticate a user against the server.
  * @method
  * @param {string} username The username.
  * @param {string} [password] The password.
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
-Admin.prototype.authenticate = function(username, password, callback) {
+Admin.prototype.authenticate = function(username, password, options, callback) {
   var self = this;
+  if(typeof options == 'function') callback = options, options = {};
+  options = shallowClone(options);
+  options.authdb = 'admin';
+  
   // Execute using callback
-  if(typeof callback == 'function') return this.s.db.authenticate(username, password, {authdb: 'admin'}, callback);
+  if(typeof callback == 'function') return this.s.db.authenticate(username, password, options, callback);
 
   // Return a Promise
   return new this.s.promiseLibrary(function(resolve, reject) {
-    self.s.db.authenticate(username, password, {authdb: 'admin'}, function(err, r) {
+    self.s.db.authenticate(username, password, options, function(err, r) {
       if(err) return reject(err);
-      resolve(r); 
+      resolve(r);
     });
-  });  
+  });
 }
 
+define.classMethod('authenticate', {callback: true, promise:true});
+
 /**
  * Logout user from server, fire off on all connections and remove all auth info
  * @method
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.logout = function(callback) {
@@ -257,11 +278,34 @@ Admin.prototype.logout = function(callback) {
   return new this.s.promiseLibrary(function(resolve, reject) {
     self.s.db.logout({authdb: 'admin'}, function(err, r) {
       if(err) return reject(err);
-      resolve(r); 
+      resolve(r);
     });
   });
 }
 
+define.classMethod('logout', {callback: true, promise:true});
+
+// Get write concern
+var writeConcern = function(options, db) {
+  options = shallowClone(options);
+
+  // If options already contain write concerns return it
+  if(options.w || options.wtimeout || options.j || options.fsync) {
+    return options;
+  }
+
+  // Set db write concern if available
+  if(db.writeConcern) {
+    if(options.w) options.w = db.writeConcern.w;
+    if(options.wtimeout) options.wtimeout = db.writeConcern.wtimeout;
+    if(options.j) options.j = db.writeConcern.j;
+    if(options.fsync) options.fsync = db.writeConcern.fsync;
+  }
+
+  // Return modified options
+  return options;
+}
+
 /**
  * Add a user to the database.
  * @method
@@ -274,7 +318,7 @@ Admin.prototype.logout = function(callback) {
  * @param {boolean} [options.fsync=false] Specify a file sync write concern.
  * @param {object} [options.customData=null] Custom data associated with the user (only Mongodb 2.6 or higher)
  * @param {object[]} [options.roles=null] Roles associated with the created user (only Mongodb 2.6 or higher)
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.addUser = function(username, password, options, callback) {
@@ -284,21 +328,26 @@ Admin.prototype.addUser = function(username, password, options, callback) {
   if(typeof callback != 'function') args.push(callback);
   options = args.length ? args.shift() : {};
   options = options || {};
+  // Get the options
+  options = writeConcern(options, self.s.db)
   // Set the db name to admin
   options.dbName = 'admin';
 
   // Execute using callback
-  if(typeof callback == 'function') return self.s.db.addUser(username, password, options, callback);
+  if(typeof callback == 'function')
+    return self.s.db.addUser(username, password, options, callback);
 
   // Return a Promise
   return new this.s.promiseLibrary(function(resolve, reject) {
     self.s.db.addUser(username, password, options, function(err, r) {
       if(err) return reject(err);
-      resolve(r); 
+      resolve(r);
     });
   });
 }
 
+define.classMethod('addUser', {callback: true, promise:true});
+
 /**
  * Remove a user from a database
  * @method
@@ -308,7 +357,7 @@ Admin.prototype.addUser = function(username, password, options, callback) {
  * @param {number} [options.wtimeout=null] The write concern timeout.
  * @param {boolean} [options.j=false] Specify a journal write concern.
  * @param {boolean} [options.fsync=false] Specify a file sync write concern.
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.removeUser = function(username, options, callback) {
@@ -318,25 +367,31 @@ Admin.prototype.removeUser = function(username, options, callback) {
   if(typeof callback != 'function') args.push(callback);
   options = args.length ? args.shift() : {};
   options = options || {};
+  // Get the options
+  options = writeConcern(options, self.s.db)
+  // Set the db name
   options.dbName = 'admin';
 
   // Execute using callback
-  if(typeof callback == 'function') return self.s.db.removeUser(username, options, callback);
+  if(typeof callback == 'function')
+    return self.s.db.removeUser(username, options, callback);
 
   // Return a Promise
   return new this.s.promiseLibrary(function(resolve, reject) {
     self.s.db.removeUser(username, options, function(err, r) {
       if(err) return reject(err);
-      resolve(r); 
+      resolve(r);
     });
   });
 }
 
+define.classMethod('removeUser', {callback: true, promise:true});
+
 /**
  * Set the current profiling level of MongoDB
  *
  * @param {string} level The new profiling level (off, slow_only, all).
- * @param {Admin~resultCallback} callback The command result callback.
+ * @param {Admin~resultCallback} [callback] The command result callback.
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.setProfilingLevel = function(level, callback) {
@@ -349,7 +404,7 @@ Admin.prototype.setProfilingLevel = function(level, callback) {
   return new this.s.promiseLibrary(function(resolve, reject) {
     setProfilingLevel(self, level, function(err, r) {
       if(err) return reject(err);
-      resolve(r); 
+      resolve(r);
     });
   });
 };
@@ -377,13 +432,15 @@ var setProfilingLevel = function(self, level, callback) {
     if(err == null && doc.ok === 1)
       return callback(null, level);
     return err != null ? callback(err, null) : callback(new Error("Error with profile command"), null);
-  });  
+  });
 }
 
+define.classMethod('setProfilingLevel', {callback: true, promise:true});
+
 /**
  * Retrive the current profiling information for MongoDB
  *
- * @param {Admin~resultCallback} callback The command result callback.
+ * @param {Admin~resultCallback} [callback] The command result callback.
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.profilingInfo = function(callback) {
@@ -396,7 +453,7 @@ Admin.prototype.profilingInfo = function(callback) {
   return new this.s.promiseLibrary(function(resolve, reject) {
     profilingInfo(self, function(err, r) {
       if(err) return reject(err);
-      resolve(r); 
+      resolve(r);
     });
   });
 };
@@ -406,15 +463,17 @@ var profilingInfo = function(self, callback) {
     self.s.topology.cursor("admin.system.profile", { find: 'system.profile', query: {}}, {}).toArray(callback);
   } catch (err) {
     return callback(err, null);
-  }  
+  }
 }
 
+define.classMethod('profilingLevel', {callback: true, promise:true});
+
 /**
  * Validate an existing collection
  *
  * @param {string} collectionName The name of the collection to validate.
  * @param {object} [options=null] Optional settings.
- * @param {Admin~resultCallback} callback The command result callback.
+ * @param {Admin~resultCallback} [callback] The command result callback.
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.validateCollection = function(collectionName, options, callback) {
@@ -426,13 +485,14 @@ Admin.prototype.validateCollection = function(collectionName, options, callback)
   options = options || {};
 
   // Execute using callback
-  if(typeof callback == 'function') return validateCollection(self, collectionName, options, callback);
+  if(typeof callback == 'function')
+    return validateCollection(self, collectionName, options, callback);
 
   // Return a Promise
   return new this.s.promiseLibrary(function(resolve, reject) {
     validateCollection(self, collectionName, options, function(err, r) {
       if(err) return reject(err);
-      resolve(r); 
+      resolve(r);
     });
   });
 };
@@ -461,13 +521,15 @@ var validateCollection = function(self, collectionName, options, callback) {
       return callback(new Error("Error: invalid collection " + collectionName), null);
 
     return callback(null, doc);
-  });  
+  });
 }
 
+define.classMethod('validateCollection', {callback: true, promise:true});
+
 /**
  * List the available databases
  *
- * @param {Admin~resultCallback} callback The command result callback.
+ * @param {Admin~resultCallback} [callback] The command result callback.
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.listDatabases = function(callback) {
@@ -479,15 +541,17 @@ Admin.prototype.listDatabases = function(callback) {
   return new this.s.promiseLibrary(function(resolve, reject) {
     self.s.db.executeDbAdminCommand({listDatabases:1}, {}, function(err, r) {
       if(err) return reject(err);
-      resolve(r); 
+      resolve(r);
     });
-  });  
+  });
 }
 
+define.classMethod('listDatabases', {callback: true, promise:true});
+
 /**
  * Get ReplicaSet status
  *
- * @param {Admin~resultCallback} callback The command result callback.
+ * @param {Admin~resultCallback} [callback] The command result callback.
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.replSetGetStatus = function(callback) {
@@ -498,10 +562,10 @@ Admin.prototype.replSetGetStatus = function(callback) {
   return new this.s.promiseLibrary(function(resolve, reject) {
     replSetGetStatus(self, function(err, r) {
       if(err) return reject(err);
-      resolve(r); 
+      resolve(r);
     });
   });
-}; 
+};
 
 var replSetGetStatus = function(self, callback) {
   self.s.db.executeDbAdminCommand({replSetGetStatus:1}, function(err, doc) {
@@ -509,7 +573,9 @@ var replSetGetStatus = function(self, callback) {
       return callback(null, doc);
     if(err) return callback(err, false);
     callback(toError(doc), false);
-  });  
+  });
 }
 
-module.exports = Admin;
+define.classMethod('replSetGetStatus', {callback: true, promise:true});
+
+module.exports = Admin;

package/lib/aggregation_cursor.js

@@ -11,6 +11,7 @@ var inherits = require('util').inherits
   , ReadPreference = require('./read_preference')
   , MongoError = require('mongodb-core').MongoError
   , Readable = require('stream').Readable || require('readable-stream').Readable
+  , Define = require('./metadata')
   , CoreCursor = require('./cursor')
   , Query = require('mongodb-core').Query
   , CoreReadPreference = require('mongodb-core').ReadPreference;
@@ -18,9 +19,9 @@ var inherits = require('util').inherits
 /**
  * @fileOverview The **AggregationCursor** class is an internal class that embodies an aggregation cursor on MongoDB
  * allowing for iteration over the results returned from the underlying query. It supports
- * one by one document iteration, conversion to an array or can be iterated as a Node 0.10.X 
+ * one by one document iteration, conversion to an array or can be iterated as a Node 0.10.X
  * or higher stream
- * 
+ *
  * **AGGREGATIONCURSOR Cannot directly be instantiated**
  * @example
  * var MongoClient = require('mongodb').MongoClient,
@@ -36,7 +37,6 @@ var inherits = require('util').inherits
  *     , {a:2, b:2}, {a:3, b:3}
  *     , {a:4, b:4}], {w:1}, function(err, result) {
  *     test.equal(null, err);
- * 
  *     // Show that duplicate records got dropped
  *     col.aggregation({}, {cursor: {}}).toArray(function(err, items) {
  *       test.equal(null, err);
@@ -104,7 +104,7 @@ var AggregationCursor = function(bson, ns, cmd, options, topology, topologyOptio
     // Topology Options
     , topologyOptions: topologyOptions
     // Promise library
-    , promiseLibrary: promiseLibrary 
+    , promiseLibrary: promiseLibrary
   }
 }
 
@@ -137,13 +137,20 @@ var AggregationCursor = function(bson, ns, cmd, options, topology, topologyOptio
  */
 
 // Inherit from Readable
-inherits(AggregationCursor, Readable);  
+inherits(AggregationCursor, Readable);
+
+// Set the methods to inherit from prototype
+var methodsToInherit = ['_next', 'next', 'each', 'forEach', 'toArray'
+  , 'rewind', 'bufferedCount', 'readBufferedDocuments', 'close', 'isClosed', 'kill'
+  , '_find', '_getmore', '_killcursor', 'isDead', 'explain', 'isNotified'];
 
 // Extend the Cursor
 for(var name in CoreCursor.prototype) {
   AggregationCursor.prototype[name] = CoreCursor.prototype[name];
 }
 
+var define = AggregationCursor.define = new Define('AggregationCursor', AggregationCursor, true);
+
 /**
  * Set the batch size for the cursor.
  * @method
@@ -152,13 +159,15 @@ for(var name in CoreCursor.prototype) {
  * @return {AggregationCursor}
  */
 AggregationCursor.prototype.batchSize = function(value) {
-  if(this.s.state == AggregationCursor.CLOSED || this.isDead()) throw new MongoError("Cursor is closed");
-  if(typeof value != 'number') throw new MongoError("batchSize requires an integer");
+  if(this.s.state == AggregationCursor.CLOSED || this.isDead()) throw MongoError.create({message: "Cursor is closed", driver:true });
+  if(typeof value != 'number') throw MongoError.create({message: "batchSize requires an integer", drvier:true });
   if(this.s.cmd.cursor) this.s.cmd.cursor.batchSize = value;
   this.setCursorBatchSize(value);
   return this;
 }
 
+define.classMethod('batchSize', {callback: false, promise:false, returns: [AggregationCursor]});
+
 /**
  * Add a geoNear stage to the aggregation pipeline
  * @method
@@ -170,6 +179,8 @@ AggregationCursor.prototype.geoNear = function(document) {
   return this;
 }
 
+define.classMethod('geoNear', {callback: false, promise:false, returns: [AggregationCursor]});
+
 /**
  * Add a group stage to the aggregation pipeline
  * @method
@@ -181,6 +192,8 @@ AggregationCursor.prototype.group = function(document) {
   return this;
 }
 
+define.classMethod('group', {callback: false, promise:false, returns: [AggregationCursor]});
+
 /**
  * Add a limit stage to the aggregation pipeline
  * @method
@@ -192,6 +205,8 @@ AggregationCursor.prototype.limit = function(value) {
   return this;
 }
 
+define.classMethod('limit', {callback: false, promise:false, returns: [AggregationCursor]});
+
 /**
  * Add a match stage to the aggregation pipeline
  * @method
@@ -203,6 +218,8 @@ AggregationCursor.prototype.match = function(document) {
   return this;
 }
 
+define.classMethod('match', {callback: false, promise:false, returns: [AggregationCursor]});
+
 /**
  * Add a maxTimeMS stage to the aggregation pipeline
  * @method
@@ -216,6 +233,8 @@ AggregationCursor.prototype.maxTimeMS = function(value) {
   return this;
 }
 
+define.classMethod('maxTimeMS', {callback: false, promise:false, returns: [AggregationCursor]});
+
 /**
  * Add a out stage to the aggregation pipeline
  * @method
@@ -227,6 +246,8 @@ AggregationCursor.prototype.out = function(destination) {
   return this;
 }
 
+define.classMethod('out', {callback: false, promise:false, returns: [AggregationCursor]});
+
 /**
  * Add a project stage to the aggregation pipeline
  * @method
@@ -238,6 +259,8 @@ AggregationCursor.prototype.project = function(document) {
   return this;
 }
 
+define.classMethod('project', {callback: false, promise:false, returns: [AggregationCursor]});
+
 /**
  * Add a redact stage to the aggregation pipeline
  * @method
@@ -249,6 +272,8 @@ AggregationCursor.prototype.redact = function(document) {
   return this;
 }
 
+define.classMethod('redact', {callback: false, promise:false, returns: [AggregationCursor]});
+
 /**
  * Add a skip stage to the aggregation pipeline
  * @method
@@ -260,6 +285,8 @@ AggregationCursor.prototype.skip = function(value) {
   return this;
 }
 
+define.classMethod('skip', {callback: false, promise:false, returns: [AggregationCursor]});
+
 /**
  * Add a sort stage to the aggregation pipeline
  * @method
@@ -271,6 +298,8 @@ AggregationCursor.prototype.sort = function(document) {
   return this;
 }
 
+define.classMethod('sort', {callback: false, promise:false, returns: [AggregationCursor]});
+
 /**
  * Add a unwind stage to the aggregation pipeline
  * @method
@@ -282,30 +311,29 @@ AggregationCursor.prototype.unwind = function(field) {
   return this;
 }
 
+define.classMethod('unwind', {callback: false, promise:false, returns: [AggregationCursor]});
+
 AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
 
+// Inherited methods
+define.classMethod('toArray', {callback: true, promise:true});
+define.classMethod('each', {callback: true, promise:false});
+define.classMethod('forEach', {callback: true, promise:false});
+define.classMethod('next', {callback: true, promise:true});
+define.classMethod('close', {callback: true, promise:true});
+define.classMethod('isClosed', {callback: false, promise:false, returns: [Boolean]});
+define.classMethod('rewind', {callback: false, promise:false});
+define.classMethod('bufferedCount', {callback: false, promise:false, returns: [Number]});
+define.classMethod('readBufferedDocuments', {callback: false, promise:false, returns: [Array]});
+
 /**
  * Get the next available document from the cursor, returns null if no more documents are available.
  * @function AggregationCursor.prototype.next
- * @param {AggregationCursor~resultCallback} callback The result callback.
+ * @param {AggregationCursor~resultCallback} [callback] The result callback.
  * @throws {MongoError}
  * @return {Promise} returns Promise if no callback passed
  */
 
-/**
- * Set the new batchSize of the cursor
- * @function AggregationCursor.prototype.setBatchSize
- * @param {number} value The new batchSize for the cursor
- * @return {null}
- */
-
-/**
- * Get the batchSize of the cursor
- * @function AggregationCursor.prototype.batchSize
- * @param {number} value The current batchSize for the cursor
- * @return {null}
- */
-
 /**
  * The callback format for results
  * @callback AggregationCursor~toArrayResultCallback
@@ -319,7 +347,7 @@ AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
  * results when this cursor had been previouly accessed. In that case,
  * cursor.rewind() can be used to reset the cursor.
  * @method AggregationCursor.prototype.toArray
- * @param {AggregationCursor~toArrayResultCallback} callback The result callback.
+ * @param {AggregationCursor~toArrayResultCallback} [callback] The result callback.
  * @throws {MongoError}
  * @return {Promise} returns Promise if no callback passed
  */
@@ -349,13 +377,13 @@ AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
  * @method AggregationCursor.prototype.close
  * @param {AggregationCursor~resultCallback} [callback] The result callback.
  * @return {Promise} returns Promise if no callback passed
- */   
+ */
 
 /**
  * Is the cursor closed
  * @method AggregationCursor.prototype.isClosed
  * @return {boolean}
- */   
+ */
 
 /**
  * Execute the explain for the cursor
@@ -368,13 +396,13 @@ AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
  * Clone the cursor
  * @function AggregationCursor.prototype.clone
  * @return {AggregationCursor}
- */     
+ */
 
 /**
  * Resets the cursor
  * @function AggregationCursor.prototype.rewind
  * @return {AggregationCursor}
- */  
+ */
 
 /**
  * The callback format for the forEach iterator method
@@ -401,4 +429,4 @@ AggregationCursor.INIT = 0;
 AggregationCursor.OPEN = 1;
 AggregationCursor.CLOSED = 2;
 
-module.exports = AggregationCursor;
+module.exports = AggregationCursor;