koa-better-response-time

koa-better-response-time

Response time for Koa.js. Inspired from response-time with same object options.

The "response time" is defined here as the elapsed time from when a request enters this middleware to when the headers are written out to the client.

Installation

# npm ..
$ npm install koa-better-response-time
# yarn ..
$ yarn add koa-better-response-time

Usage

This is a practical example of how to use.

const Koa = require('koa');
const xResponseTime = require('koa-better-response-time');
const app = new Koa();

// You can pass options object to xResponseTime.
app.use(xResponseTime());

OPTIONS

You can pass an object that contains these keys to the xResponseTime middleware:

• digits — (Number) The fixed number of digits to include in the output. default to 3 (ex: 2.300ms).
• headerName — (String) Header name to use. default to 'X-Response-Time'
• suffix — (Boolean) Display 'ms' beside the time. default to true (ex: 2.300ms vs 2.300).

Note

Best to .use() at the top before any other middleware, to wrap all subsequent middleware.

License

MIT © Imed Jaberi