Accept string for maxAge

HISTORY.md

@@ -1,6 +1,7 @@
 unreleased
 ==========
 
+  * Accept string for `maxAge` (converted by `ms`)
   * Use `etag` to generate `ETag` header
 
 2.0.1 / 2014-06-05

README.md

@@ -27,7 +27,9 @@ Serve favicon accepts these properties in the options object.
 
 ##### maxAge
 
-The `cache-control` `max-age` directive in `ms`, defaulting to 1 day.
+The `cache-control` `max-age` directive in `ms`, defaulting to 1 day. This can
+also be a string accepted by the [ms](https://www.npmjs.org/package/ms#readme)
+module.
 
 ## Examples
 

index.js

@@ -13,9 +13,16 @@
 var etag = require('etag');
 var fresh = require('fresh');
 var fs = require('fs');
+var ms = require('ms');
 var path = require('path');
 var resolve = path.resolve;
 
+/**
+ * Module variables.
+ */
+
+var maxMaxAge = 60 * 60 * 24 * 365 * 1000; // 1 year
+
 /**
  * Serves the favicon located by the given `path`.
  *
@@ -30,9 +37,7 @@ module.exports = function favicon(path, options){
 
   var buf;
   var icon; // favicon cache
-  var maxAge = options.maxAge == null
-    ? 86400000
-    : Math.min(Math.max(0, options.maxAge), 31556926000);
+  var maxAge = calcMaxAge(options.maxAge);
   var stat;
 
   if (!path) throw new TypeError('path to favicon.ico is required');
@@ -70,6 +75,16 @@ module.exports = function favicon(path, options){
   };
 };
 
+function calcMaxAge(val) {
+  var num = typeof val === 'string'
+    ? ms(val)
+    : val;
+
+  return num != null
+    ? Math.min(Math.max(0, num), maxMaxAge)
+    : maxMaxAge
+}
+
 function createIcon(buf, maxAge) {
   return {
     body: buf,

package.json

@@ -17,6 +17,7 @@
   "devDependencies": {
     "istanbul": "0.3.0",
     "mocha": "~1.21.4",
+    "ms": "0.6.2",
     "proxyquire": "~1.0.1",
     "should": "~4.0.1",
     "supertest": "~0.13.0"

test/test.js

@@ -66,6 +66,14 @@ describe('favicon()', function(){
         .expect(200, done);
       })
 
+      it('should accept string', function(done){
+        var server = createServer(null, {maxAge: '30d'});
+        request(server)
+        .get('/favicon.ico')
+        .expect('Cache-Control', 'public, max-age=2592000')
+        .expect(200, done);
+      })
+
       it('should be valid delta-seconds', function(done){
         var server = createServer(null, {maxAge: 1234});
         request(server)
@@ -82,19 +90,19 @@ describe('favicon()', function(){
         .expect(200, done);
       })
 
-      it('should ceil at 31556926', function(done){
+      it('should ceil at 1 year', function(done){
         var server = createServer(null, {maxAge: 900000000000});
         request(server)
         .get('/favicon.ico')
-        .expect('Cache-Control', 'public, max-age=31556926')
+        .expect('Cache-Control', 'public, max-age=31536000')
         .expect(200, done);
       })
 
       it('should accept Inifnity', function(done){
         var server = createServer(null, {maxAge: Infinity});
         request(server)
         .get('/favicon.ico')
-        .expect('Cache-Control', 'public, max-age=31556926')
+        .expect('Cache-Control', 'public, max-age=31536000')
         .expect(200, done);
       })
     })