Add header option for custom header name

closes #3

HISTORY.md

@@ -1,6 +1,7 @@
 unreleased
 ==========
 
+  * Add `header` option for custom header name
   * Change `digits` argument to an `options` argument
 
 2.0.1 / 2014-08-10

README.md

@@ -6,7 +6,7 @@
 [![Test Coverage][coveralls-image]][coveralls-url]
 [![Gratipay][gratipay-image]][gratipay-url]
 
-X-Response-Time header for node.js
+Response time header for node.js
 
 ## Installation
 
@@ -33,6 +33,10 @@ Returns middleware that adds a `X-Response-Time` header to responses.
 The fixed number of digits to include in the output, which is always in
 milliseconds, defaults to `3` (ex: `2.300ms`).
 
+##### header
+
+The name of the header to set, defaults to `X-Response-Time`.
+
 ## Examples
 
 ### express/connect

index.js

@@ -39,16 +39,21 @@ module.exports = function responseTime(options) {
     ? options.digits
     : 3
 
+  // header name
+  var header = options.header || 'X-Response-Time'
+
   return function responseTime(req, res, next) {
     var startAt = process.hrtime()
 
     onHeaders(res, function () {
-      if (this.getHeader('X-Response-Time')) return;
+      if (this.getHeader(header)) {
+        return
+      }
 
       var diff = process.hrtime(startAt)
       var ms = diff[0] * 1e3 + diff[1] * 1e-6
 
-      this.setHeader('X-Response-Time', ms.toFixed(digits) + 'ms')
+      this.setHeader(header, ms.toFixed(digits) + 'ms')
     })
 
     next()

package.json

@@ -1,12 +1,18 @@
 {
   "name": "response-time",
-  "description": "X-Response-Time header for node.js",
+  "description": "Response time header for node.js",
   "version": "2.0.1",
   "author": "Jonathan Ong <[email protected]> (http://jongleberry.com)",
   "contributors": [
     "Douglas Christopher Wilson <[email protected]>"
   ],
   "license": "MIT",
+  "keywords": [
+    "http",
+    "res",
+    "response time",
+    "x-response-time"
+  ],
   "repository": "expressjs/response-time",
   "dependencies": {
     "depd": "0.4.5",

test/test.js

@@ -70,6 +70,22 @@ describe('responseTime(options)', function () {
       .expect('X-Response-Time', /^[0-9]+ms$/, done)
     })
   })
+
+  describe('with "header" option', function () {
+    it('should default to X-Response-Time', function (done) {
+      var server = createServer()
+      request(server)
+      .get('/')
+      .expect('X-Response-Time', /^[0-9\.]+ms$/, done)
+    })
+
+    it('should allow custom header name', function (done) {
+      var server = createServer({ header: 'X-Time-Taken' })
+      request(server)
+      .get('/')
+      .expect('X-Time-Taken', /^[0-9\.]+ms$/, done)
+    })
+  })
 })
 
 function createServer(opts, fn) {