Deprecate hidden method in favor of setting through options

History.md

@@ -2,6 +2,7 @@ unreleased
 ==========
 
  * Deprecate `send.etag()` -- use `etag` in `options`
+ * Deprecate `send.hidden()` -- use `hidden` in `options`
  * deps: debug@1.0.3
    - Add support for multiple wildcards in namespaces
 

Readme.md

@@ -114,10 +114,6 @@ var app = http.createServer(function(req, res){
   This can also be a string accepted by the
   [ms](https://www.npmjs.org/package/ms#readme) module.
 
-### .hidden(bool)
-
-  Enable or disable transfer of hidden files, defaults to false.
-
 ## Error-handling
 
   By default when no `error` listeners are present an automatic response will be made, otherwise you have full control over the response, aka you may show a 5xx page etc.

lib/send.js

@@ -84,8 +84,9 @@ function SendStream(req, path, options) {
     ? Boolean(options.etag)
     : true
 
+  this._hidden = Boolean(options.hidden)
+
   this.maxage(options.maxage);
-  this.hidden(options.hidden);
   this.index(('index' in options) ? options.index : 'index.html');
   if (options.root || options.from) this.root(options.root || options.from);
 }
@@ -119,12 +120,12 @@ SendStream.prototype.etag = deprecate.function(function etag(val) {
  * @api public
  */
 
-SendStream.prototype.hidden = function(val){
+SendStream.prototype.hidden = deprecate.function(function hidden(val) {
   val = Boolean(val);
   debug('hidden %s', val);
   this._hidden = val;
   return this;
-};
+}, 'send.hidden: pass hidden as option');
 
 /**
  * Set index `paths`, set to a falsy

test/send.js

@@ -569,6 +569,20 @@ describe('send(file).pipe(res)', function(){
       });
     })
   })
+
+  describe('.hidden()', function(){
+    it('should default support sending hidden files', function(done){
+      var app = http.createServer(function(req, res){
+        send(req, req.url, {root: fixtures})
+        .hidden(true)
+        .pipe(res);
+      });
+
+      request(app)
+      .get('/.hidden')
+      .expect(200, /secret/, done);
+    })
+  })
 })
 
 describe('send(file, options)', function(){
@@ -589,6 +603,25 @@ describe('send(file, options)', function(){
     })
   })
 
+  describe('hidden', function(){
+    it('should default to false', function(done){
+      request(app)
+      .get('/.hidden')
+      .expect(404, 'Not Found', done)
+    })
+
+    it('should default support sending hidden files', function(done){
+      var app = http.createServer(function(req, res){
+        send(req, req.url, {hidden: true, root: fixtures})
+        .pipe(res);
+      });
+
+      request(app)
+      .get('/.hidden')
+      .expect(200, /secret/, done)
+    })
+  })
+
   describe('maxAge', function(){
     it('should default to 0', function(done){
       request(app)
@@ -707,14 +740,6 @@ describe('send(file, options)', function(){
     })
   })
 
-  describe('hidden', function(){
-    it('should default to false', function(done){
-      request(app)
-      .get('/.secret')
-      .expect(404, 'Not Found', done)
-    })
-  })
-
   describe('root', function(){
     it('should set with deprecated from', function(done){
       var app = http.createServer(function(req, res){