mongodb 2.2.36 → 3.0.2

package/lib/aggregation_cursor.js

@@ -1,27 +1,29 @@
-"use strict";
+'use strict';
 
-var inherits = require('util').inherits
-  , MongoError = require('mongodb-core').MongoError
-  , Readable = require('stream').Readable || require('readable-stream').Readable
-  , Define = require('./metadata')
-  , CoreCursor = require('./cursor');
+var inherits = require('util').inherits,
+  MongoError = require('mongodb-core').MongoError,
+  Readable = require('stream').Readable,
+  Define = require('./metadata'),
+  CoreCursor = require('./cursor');
 
 /**
  * @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 4.X
  * or higher stream
  *
  * **AGGREGATIONCURSOR Cannot directly be instantiated**
  * @example
- * var MongoClient = require('mongodb').MongoClient,
- *   test = require('assert');
+ * const MongoClient = require('mongodb').MongoClient;
+ * const test = require('assert');
  * // Connection url
- * var url = 'mongodb://localhost:27017/test';
+ * const url = 'mongodb://localhost:27017';
+ * // Database Name
+ * const dbName = 'test';
  * // Connect using MongoClient
- * MongoClient.connect(url, function(err, db) {
+ * MongoClient.connect(url, function(err, client) {
  *   // Create a collection we want to drop later
- *   var col = db.collection('createIndexExample1');
+ *   const col = client.db(dbName).collection('createIndexExample1');
  *   // Insert a bunch of documents
  *   col.insert([{a:1, b:1}
  *     , {a:2, b:2}, {a:3, b:3}
@@ -31,7 +33,7 @@ var inherits = require('util').inherits
  *     col.aggregation({}, {cursor: {}}).toArray(function(err, items) {
  *       test.equal(null, err);
  *       test.equal(4, items.length);
- *       db.close();
+ *       client.close();
  *     });
  *   });
  * });
@@ -61,41 +63,35 @@ var AggregationCursor = function(bson, ns, cmd, options, topology, topologyOptio
   var maxTimeMS = null;
 
   // Get the promiseLibrary
-  var promiseLibrary = options.promiseLibrary;
-
-  // No promise library selected fall back
-  if(!promiseLibrary) {
-    promiseLibrary = typeof global.Promise == 'function' ?
-      global.Promise : require('es6-promise').Promise;
-  }
+  var promiseLibrary = options.promiseLibrary || Promise;
 
   // Set up
-  Readable.call(this, {objectMode: true});
+  Readable.call(this, { objectMode: true });
 
   // Internal state
   this.s = {
     // MaxTimeMS
-      maxTimeMS: maxTimeMS
+    maxTimeMS: maxTimeMS,
     // State
-    , state: state
+    state: state,
     // Stream options
-    , streamOptions: streamOptions
+    streamOptions: streamOptions,
     // BSON
-    , bson: bson
+    bson: bson,
     // Namespace
-    , ns: ns
+    ns: ns,
     // Command
-    , cmd: cmd
+    cmd: cmd,
     // Options
-    , options: options
+    options: options,
     // Topology
-    , topology: topology
+    topology: topology,
     // Topology Options
-    , topologyOptions: topologyOptions
+    topologyOptions: topologyOptions,
     // Promise library
-    , promiseLibrary: promiseLibrary
-  }
-}
+    promiseLibrary: promiseLibrary
+  };
+};
 
 /**
  * AggregationCursor stream data event, fired for each document in the cursor.
@@ -129,11 +125,11 @@ var AggregationCursor = function(bson, ns, cmd, options, topology, topologyOptio
 inherits(AggregationCursor, Readable);
 
 // Extend the Cursor
-for(var name in CoreCursor.prototype) {
+for (var name in CoreCursor.prototype) {
   AggregationCursor.prototype[name] = CoreCursor.prototype[name];
 }
 
-var define = AggregationCursor.define = new Define('AggregationCursor', AggregationCursor, true);
+var define = (AggregationCursor.define = new Define('AggregationCursor', AggregationCursor, true));
 
 /**
  * Set the batch size for the cursor.
@@ -143,14 +139,16 @@ var define = AggregationCursor.define = new Define('AggregationCursor', Aggregat
  * @return {AggregationCursor}
  */
 AggregationCursor.prototype.batchSize = function(value) {
-  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", driver:true });
-  if(this.s.cmd.cursor) this.s.cmd.cursor.batchSize = value;
+  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]});
+define.classMethod('batchSize', { callback: false, promise: false, returns: [AggregationCursor] });
 
 /**
  * Add a geoNear stage to the aggregation pipeline
@@ -159,11 +157,11 @@ define.classMethod('batchSize', {callback: false, promise:false, returns: [Aggre
  * @return {AggregationCursor}
  */
 AggregationCursor.prototype.geoNear = function(document) {
-  this.s.cmd.pipeline.push({$geoNear: document});
+  this.s.cmd.pipeline.push({ $geoNear: document });
   return this;
-}
+};
 
-define.classMethod('geoNear', {callback: false, promise:false, returns: [AggregationCursor]});
+define.classMethod('geoNear', { callback: false, promise: false, returns: [AggregationCursor] });
 
 /**
  * Add a group stage to the aggregation pipeline
@@ -172,11 +170,11 @@ define.classMethod('geoNear', {callback: false, promise:false, returns: [Aggrega
  * @return {AggregationCursor}
  */
 AggregationCursor.prototype.group = function(document) {
-  this.s.cmd.pipeline.push({$group: document});
+  this.s.cmd.pipeline.push({ $group: document });
   return this;
-}
+};
 
-define.classMethod('group', {callback: false, promise:false, returns: [AggregationCursor]});
+define.classMethod('group', { callback: false, promise: false, returns: [AggregationCursor] });
 
 /**
  * Add a limit stage to the aggregation pipeline
@@ -185,11 +183,11 @@ define.classMethod('group', {callback: false, promise:false, returns: [Aggregati
  * @return {AggregationCursor}
  */
 AggregationCursor.prototype.limit = function(value) {
-  this.s.cmd.pipeline.push({$limit: value});
+  this.s.cmd.pipeline.push({ $limit: value });
   return this;
-}
+};
 
-define.classMethod('limit', {callback: false, promise:false, returns: [AggregationCursor]});
+define.classMethod('limit', { callback: false, promise: false, returns: [AggregationCursor] });
 
 /**
  * Add a match stage to the aggregation pipeline
@@ -198,11 +196,11 @@ define.classMethod('limit', {callback: false, promise:false, returns: [Aggregati
  * @return {AggregationCursor}
  */
 AggregationCursor.prototype.match = function(document) {
-  this.s.cmd.pipeline.push({$match: document});
+  this.s.cmd.pipeline.push({ $match: document });
   return this;
-}
+};
 
-define.classMethod('match', {callback: false, promise:false, returns: [AggregationCursor]});
+define.classMethod('match', { callback: false, promise: false, returns: [AggregationCursor] });
 
 /**
  * Add a maxTimeMS stage to the aggregation pipeline
@@ -211,13 +209,13 @@ define.classMethod('match', {callback: false, promise:false, returns: [Aggregati
  * @return {AggregationCursor}
  */
 AggregationCursor.prototype.maxTimeMS = function(value) {
-  if(this.s.topology.lastIsMaster().minWireVersion > 2) {
+  if (this.s.topology.lastIsMaster().minWireVersion > 2) {
     this.s.cmd.maxTimeMS = value;
   }
   return this;
-}
+};
 
-define.classMethod('maxTimeMS', {callback: false, promise:false, returns: [AggregationCursor]});
+define.classMethod('maxTimeMS', { callback: false, promise: false, returns: [AggregationCursor] });
 
 /**
  * Add a out stage to the aggregation pipeline
@@ -226,11 +224,11 @@ define.classMethod('maxTimeMS', {callback: false, promise:false, returns: [Aggre
  * @return {AggregationCursor}
  */
 AggregationCursor.prototype.out = function(destination) {
-  this.s.cmd.pipeline.push({$out: destination});
+  this.s.cmd.pipeline.push({ $out: destination });
   return this;
-}
+};
 
-define.classMethod('out', {callback: false, promise:false, returns: [AggregationCursor]});
+define.classMethod('out', { callback: false, promise: false, returns: [AggregationCursor] });
 
 /**
  * Add a project stage to the aggregation pipeline
@@ -239,11 +237,11 @@ define.classMethod('out', {callback: false, promise:false, returns: [Aggregation
  * @return {AggregationCursor}
  */
 AggregationCursor.prototype.project = function(document) {
-  this.s.cmd.pipeline.push({$project: document});
+  this.s.cmd.pipeline.push({ $project: document });
   return this;
-}
+};
 
-define.classMethod('project', {callback: false, promise:false, returns: [AggregationCursor]});
+define.classMethod('project', { callback: false, promise: false, returns: [AggregationCursor] });
 
 /**
  * Add a lookup stage to the aggregation pipeline
@@ -252,11 +250,11 @@ define.classMethod('project', {callback: false, promise:false, returns: [Aggrega
  * @return {AggregationCursor}
  */
 AggregationCursor.prototype.lookup = function(document) {
-  this.s.cmd.pipeline.push({$lookup: document});
+  this.s.cmd.pipeline.push({ $lookup: document });
   return this;
-}
+};
 
-define.classMethod('lookup', {callback: false, promise:false, returns: [AggregationCursor]});
+define.classMethod('lookup', { callback: false, promise: false, returns: [AggregationCursor] });
 
 /**
  * Add a redact stage to the aggregation pipeline
@@ -265,11 +263,11 @@ define.classMethod('lookup', {callback: false, promise:false, returns: [Aggregat
  * @return {AggregationCursor}
  */
 AggregationCursor.prototype.redact = function(document) {
-  this.s.cmd.pipeline.push({$redact: document});
+  this.s.cmd.pipeline.push({ $redact: document });
   return this;
-}
+};
 
-define.classMethod('redact', {callback: false, promise:false, returns: [AggregationCursor]});
+define.classMethod('redact', { callback: false, promise: false, returns: [AggregationCursor] });
 
 /**
  * Add a skip stage to the aggregation pipeline
@@ -278,11 +276,11 @@ define.classMethod('redact', {callback: false, promise:false, returns: [Aggregat
  * @return {AggregationCursor}
  */
 AggregationCursor.prototype.skip = function(value) {
-  this.s.cmd.pipeline.push({$skip: value});
+  this.s.cmd.pipeline.push({ $skip: value });
   return this;
-}
+};
 
-define.classMethod('skip', {callback: false, promise:false, returns: [AggregationCursor]});
+define.classMethod('skip', { callback: false, promise: false, returns: [AggregationCursor] });
 
 /**
  * Add a sort stage to the aggregation pipeline
@@ -291,11 +289,11 @@ define.classMethod('skip', {callback: false, promise:false, returns: [Aggregatio
  * @return {AggregationCursor}
  */
 AggregationCursor.prototype.sort = function(document) {
-  this.s.cmd.pipeline.push({$sort: document});
+  this.s.cmd.pipeline.push({ $sort: document });
   return this;
-}
+};
 
-define.classMethod('sort', {callback: false, promise:false, returns: [AggregationCursor]});
+define.classMethod('sort', { callback: false, promise: false, returns: [AggregationCursor] });
 
 /**
  * Add a unwind stage to the aggregation pipeline
@@ -304,25 +302,25 @@ define.classMethod('sort', {callback: false, promise:false, returns: [Aggregatio
  * @return {AggregationCursor}
  */
 AggregationCursor.prototype.unwind = function(field) {
-  this.s.cmd.pipeline.push({$unwind: field});
+  this.s.cmd.pipeline.push({ $unwind: field });
   return this;
-}
+};
 
-define.classMethod('unwind', {callback: false, promise:false, returns: [AggregationCursor]});
+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('hasNext', {callback: true, promise:true});
-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]});
+define.classMethod('toArray', { callback: true, promise: true });
+define.classMethod('each', { callback: true, promise: false });
+define.classMethod('forEach', { callback: true, promise: false });
+define.classMethod('hasNext', { callback: true, promise: true });
+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.
@@ -350,7 +348,7 @@ define.classMethod('readBufferedDocuments', {callback: false, promise:false, ret
 /**
  * Returns an array of documents. The caller is responsible for making sure that there
  * is enough memory to store the results. Note that the array only contain partial
- * results when this cursor had been previously accessed. In that case,
+ * 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.
@@ -367,7 +365,7 @@ define.classMethod('readBufferedDocuments', {callback: false, promise:false, ret
 
 /**
  * Iterates over all the documents for this cursor. As with **{cursor.toArray}**,
- * not all of the elements will be iterated if this cursor had been previously accessed.
+ * not all of the elements will be iterated if this cursor had been previouly accessed.
  * In that case, **{cursor.rewind}** can be used to reset the cursor. However, unlike
  * **{cursor.toArray}**, the cursor will only hold a maximum of batch size elements
  * at any given time if batch size is specified. Otherwise, the caller is responsible