change etag and lastModified setting

README.md

@@ -37,8 +37,8 @@ app.use(serve(staticPath, {
   },
   dotfiles: 'allow',
   denyQuerystring: true,
-  disableETag: true,
-  disableLastModified: true,
+  etag: false,
+  lastModified: false,
   '404': 'next',
 }));
 const port = process.env.PORT || 10000;
@@ -50,23 +50,23 @@ console.dir('server listen on:' + port);
 
 ### options
 
-- `maxAge` static file's http response header, Cache-Control max-age
+- `maxAge` Static file's http response header, Cache-Control max-age, default is 0.
 
-- `sMaxAge` static file's http response header, Cache-Control s-maxage for cache application(eg. varnish)
+- `sMaxAge` Static file's http response header, Cache-Control s-maxage for cache application(eg. varnish). If not set, it will be Math.min(3600, maxAge).
 
-- `headers` default header
+- `headers` The default header.
 
-- `dotfiles` dot file access permission, it can be 'allow', 'deny', 'ignore'. Default is 'ignore'
+- `dotfiles` Dot file access permission, it can be 'allow', 'deny', 'ignore'. Default is 'ignore'.
 
-- `denyQuerystring` deny query string, default is `false`. If using a http cache server(varnish) for the static files, query string should be denied. 
+- `denyQuerystring` Deny query string, default is `false`. If using a http cache server(varnish) for the static files, query string should be denied. Otherwise there will be different cache for the same file.
 
-- `charset` default content charset
+- `charset` Default content charset.
 
-- `disableETag` disable etag header
+- `etag` Enable or disable etag generation, default is true.
 
-- `disableLastModified` disable last-modified header
+- `lastModified` Set the Last-Modified header to the last modified date of the file on the OS, default is true.
 
-- `404` set not found handler. If set 'next', it will call next when not found, otherwise will throw an error (404).
+- `404` Set not found handler. If set 'next', it will call next when not found, otherwise will throw an error (404).
 
 ## License
 

examples/app.js

@@ -11,8 +11,8 @@ app.use(serve(staticPath, {
   },
   dotfiles: 'allow',
   denyQuerystring: true,
-  disableETag: true,
-  disableLastModified: true,
+  etag: false,
+  lastModified: false,
   '404': 'next',
 }));
 const port = process.env.PORT || 10000;

lib/serve.js

@@ -35,8 +35,15 @@ function exists(file) {
  * @return {[type]}            [description]
  */
 function serve(staticPath, options) {
-  const opts = options || {};
+  const opts = Object.assign({
+    etag: true,
+    lastModified: true,
+  }, options);
   debug('static path:%s, opts:%j', staticPath, opts);
+  if (options && (options.disableETag || options.disableLastModified)) {
+    /* eslint max-len:0 no-console:0 */
+    console.warn('disableETag and disableLastModified is deprecated, please use etag and lastModified.');
+  }
   const maxAge = opts.maxAge || 0;
   const sMaxAge = opts.sMaxAge || Math.min(3600, maxAge);
   const root = path.resolve(staticPath);
@@ -46,17 +53,6 @@ function serve(staticPath, options) {
   const defaultCharset = opts.charset || 'utf-8';
   opts.dotfiles = accessList.indexOf(opts.dotfiles) === -1 ? 'ignore' : opts.dotfiles;
 
-  const getHeaders = () => {
-    const headers = {};
-    if (!defaultHeaders) {
-      return headers;
-    }
-    Object.keys(defaultHeaders).forEach((key) => {
-      headers[key] = defaultHeaders[key];
-    });
-    return headers;
-  };
-
   return (ctx, next) => {
     if (ctx.status !== 404) {
       return next();
@@ -67,10 +63,10 @@ function serve(staticPath, options) {
     const file = path.join(root, ctx.path);
     const basename = path.basename(file);
     let access = accessList[0];
-    if (basename.charAt(0) === '.') {
-      access = opts.dotfiles;
-    } else if (file.indexOf(root) !== 0) {
+    if (file.indexOf(root) !== 0) {
       access = 'deny';
+    } else if (basename.charAt(0) === '.') {
+      access = opts.dotfiles;
     }
     switch (access) {
       case 'allow':
@@ -84,11 +80,11 @@ function serve(staticPath, options) {
     return exists(file).then((stats) => {
       const type = mime.lookup(file);
       const charset = mime.charsets.lookup(type) || defaultCharset;
-      const headers = getHeaders();
-      if (!options || !options.disableETag) {
+      const headers = Object.assign({}, defaultHeaders);
+      if (opts.etag) {
         headers.ETag = etag(stats);
       }
-      if (!options || !options.disableLastModified) {
+      if (opts.lastModified) {
         headers['Last-Modified'] = stats.mtime.toUTCString();
       }
       headers['Content-Length'] = stats.size;
@@ -109,7 +105,7 @@ function serve(staticPath, options) {
       }
       return next();
     }).catch(err => {
-      if (options && options['404'] === 'next') {
+      if (opts['404'] === 'next') {
         return next();
       }
       throw err;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "koa-static-serve",
   "description": "static serve middlware for koa",
-  "version": "2.0.9",
+  "version": "2.1.0",
   "author": "Tree Xie <vicansocanbico@gmail.com>",
   "keywords": [
     "koa",

test/serve.js

@@ -189,7 +189,7 @@ describe('serve', function() {
   it('should disable ETag', done => {
     const app = new Koa();
     app.use(serve(assets, {
-      disableETag: true,
+      etag: false,
     }));
     request(app.listen())
       .get('/test.js')
@@ -206,7 +206,7 @@ describe('serve', function() {
   it('should disable Last-Modified', done => {
     const app = new Koa();
     app.use(serve(assets, {
-      disableLastModified: true,
+      lastModified: false,
     }));
     request(app.listen())
       .get('/test.js')