disableEtag --> disableETag

vicanso · Sep 3, 2016 · 23c9e59 · 23c9e59
1 parent 7f17e6e
commit 23c9e59
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,9 @@
 $ npm i koa-static-serve
 ```
 
-
+## Examples
+
+View the [./examples](examples) directory for working examples. 
 
 ## API
 
@@ -28,7 +30,16 @@ const app = new Koa();
 const serve = require('koa-static-serve');
 const staticPath = path.join(__dirname, '..');
 app.use(serve(staticPath, {
-  maxAge : 600
+  maxAge: 3600,
+  sMaxAge: 600,
+  headers: {
+    'X-Server': 'koa-static-serve',
+  },
+  dotfiles: 'allow',
+  denyQuerystring: true,
+  disableETag: true,
+  disableLastModified: true,
+  '404': 'next',
 }));
 const port = process.env.PORT || 10000;
 app.listen(port);
@@ -51,7 +62,7 @@ console.dir('server listen on:' + port);
 
 - `charset` default content charset
 
-- `disableEtag` disable etag header
+- `disableETag` disable etag header
 
 - `disableLastModified` disable last-modified header
 

diff --git a/examples/app.js b/examples/app.js
@@ -4,7 +4,16 @@ const app = new Koa();
 const serve = require('../lib/serve');
 const staticPath = path.join(__dirname, '../assets');
 app.use(serve(staticPath, {
-  maxAge : 600
+  maxAge: 3600,
+  sMaxAge: 600,
+  headers: {
+    'X-Server': 'koa-static-serve',
+  },
+  dotfiles: 'allow',
+  denyQuerystring: true,
+  disableETag: true,
+  disableLastModified: true,
+  '404': 'next',
 }));
 const port = process.env.PORT || 10000;
 app.listen(port);

diff --git a/lib/serve.js b/lib/serve.js
@@ -86,7 +86,7 @@ function serve(staticPath, options) {
       const type = mime.lookup(file);
       const charset = mime.charsets.lookup(type) || defaultCharset;
       const headers = getHeaders();
-      if (!options || !options.disableEtag) {
+      if (!options || !options.disableETag) {
         headers.ETag = etag(stats);
       }
       if (!options || !options.disableLastModified) {

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "koa-static-serve",
   "description": "static serve middlware for koa",
-  "version": "2.0.7",
+  "version": "2.0.8",
   "author": "Tree Xie <vicansocanbico@gmail.com>",
   "keywords": [
     "koa",

diff --git a/test/serve.js b/test/serve.js
@@ -143,7 +143,7 @@ describe('serve', function() {
   it('should disable ETag', done => {
     const app = new Koa();
     app.use(serve(assets, {
-      disableEtag: true,
+      disableETag: true,
     }));
     request(app.listen())
       .get('/test.js')