feat: remove "maxScan"

Author: hasezoey

README.md

@@ -99,7 +99,6 @@ require('mongodb').connect(uri, function (err, db) {
     - [hint()](#hint)
     - [j()](#j)
     - [limit()](#limit)
-    - [maxScan()](#maxscan)
     - [maxTime()](#maxtime)
     - [skip()](#skip)
     - [sort()](#sort)
@@ -829,18 +828,6 @@ _Cannot be used with `distinct()`._
 
 [MongoDB documentation](http://docs.mongodb.org/manual/reference/method/cursor.limit/)
 
-### maxScan()
-
-Specifies the maxScan option.
-
-```js
-query.maxScan(100)
-```
-
-_Cannot be used with `distinct()`._
-
-[MongoDB documentation](http://docs.mongodb.org/manual/reference/operator/maxScan/)
-
 ### maxTime()
 
 Specifies the maxTimeMS option.
@@ -1161,7 +1148,6 @@ mquery().setOptions({ collection: coll, limit: 20 })
 - [sort](#sort) *
 - [limit](#limit) *
 - [skip](#skip) *
-- [maxScan](#maxscan) *
 - [maxTime](#maxtime) *
 - [batchSize](#batchSize) *
 - [comment](#comment) *

lib/mquery.js

@@ -148,7 +148,6 @@ Query.prototype.toConstructor = function toConstructor() {
  * - [sort](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Bsort(\)%7D%7D) *
  * - [limit](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Blimit%28%29%7D%7D) *
  * - [skip](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Bskip%28%29%7D%7D) *
- * - [maxScan](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24maxScan) *
  * - [maxTime](http://docs.mongodb.org/manual/reference/operator/meta/maxTimeMS/#op._S_maxTimeMS) *
  * - [batchSize](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7BbatchSize%28%29%7D%7D) *
  * - [comment](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24comment) *
@@ -1389,23 +1388,6 @@ function _pushMap(opts, map) {
  * @see mongodb http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Bskip%28%29%7D%7D
  * @api public
  */
-/**
- * Specifies the maxScan option.
- *
- * #### Example:
- *
- *     query.maxScan(100)
- *
- * #### Note:
- *
- * Cannot be used with `distinct()`
- *
- * @method maxScan
- * @memberOf Query
- * @param {Number} val
- * @see mongodb http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24maxScan
- * @api public
- */
 /**
  * Specifies the batchSize option.
  *
@@ -1442,14 +1424,14 @@ function _pushMap(opts, map) {
  */
 
 /*!
- * limit, skip, maxScan, batchSize, comment
+ * limit, skip, batchSize, comment
  *
  * Sets these associated options.
  *
  *     query.comment('feed query');
  */
 
-['limit', 'skip', 'maxScan', 'batchSize', 'comment'].forEach(function(method) {
+['limit', 'skip', 'batchSize', 'comment'].forEach(function(method) {
   Query.prototype[method] = function(v) {
     this._validate(method);
     this.options[method] = v;

lib/permissions.js

@@ -26,7 +26,6 @@ denied.distinct.sort =
 denied.distinct.limit =
 denied.distinct.skip =
 denied.distinct.batchSize =
-denied.distinct.maxScan =
 denied.distinct.snapshot =
 denied.distinct.hint =
 denied.distinct.tailable = true;
@@ -53,7 +52,6 @@ denied.findOneAndRemove = function(self) {
 denied.findOneAndUpdate.limit =
 denied.findOneAndUpdate.skip =
 denied.findOneAndUpdate.batchSize =
-denied.findOneAndUpdate.maxScan =
 denied.findOneAndUpdate.snapshot =
 denied.findOneAndUpdate.tailable = true;
 
@@ -79,6 +77,5 @@ denied.count = function(self) {
 
 denied.count.slice =
 denied.count.batchSize =
-denied.count.maxScan =
 denied.count.snapshot =
 denied.count.tailable = true;

test/index.js

@@ -1216,7 +1216,6 @@ describe('mquery', function() {
   const negated = {
     limit: { distinct: false, count: true },
     skip: { distinct: false, count: true },
-    maxScan: { distinct: false, count: false },
     batchSize: { distinct: false, count: false },
     maxTime: { distinct: true, count: true, name: 'maxTimeMS' }
   };
@@ -1711,13 +1710,6 @@ describe('mquery', function() {
         done();
       });
 
-      it('maxScan', function(done) {
-        assert.throws(function() {
-          mquery().maxScan(300).count();
-        }, /maxScan cannot be used with count/);
-        done();
-      });
-
       it('snapshot', function(done) {
         assert.throws(function() {
           mquery().snapshot().count();
@@ -1889,13 +1881,6 @@ describe('mquery', function() {
         done();
       });
 
-      it('maxScan', function(done) {
-        assert.throws(function() {
-          mquery().maxScan(300).distinct();
-        }, /maxScan cannot be used with distinct/);
-        done();
-      });
-
       it('snapshot', function(done) {
         assert.throws(function() {
           mquery().snapshot().distinct();
@@ -2126,13 +2111,6 @@ describe('mquery', function() {
         done();
       });
 
-      it('maxScan', function(done) {
-        assert.throws(function() {
-          mquery().maxScan(300)[method]();
-        }, new RegExp('maxScan cannot be used with ' + method));
-        done();
-      });
-
       it('snapshot', function(done) {
         assert.throws(function() {
           mquery().snapshot()[method]();