koa-server-timestamp

Create a middleware to add a server timestamp header in milliseconds. Use for Koa v2

Note

This branch is use to Koa v2.x. To use Koa v0.x & v1.x, please check the 1.x branch.

Installation

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install --save koa-server-timestamp@2

The default koa-server-timestamp is for koa v2.x

$ npm i --save koa-server-timestamp

API

let serverTimestamp = require('koa-server-timestamp');

serverTimestamp([options])

Create a middleware that adds a X-Server-Timestamp header to responses. If you don't want to use this module to automatically set a header, please see the section about Options format

Options

The serverTimestamp function accepts an optional options object that may contain any of the following keys:

header

The name of the header to set, defaults to X-Server-Timestamp.

format

This is a function that formats timestamps.

Examples

default

const serverTimestamp = require('./');
const Koa = require('koa');
const app = new Koa();

app.use(serverTimestamp());

// response
app.use(ctx => {
    /*
        Body results:
        {
            "x-server-timestamp": "1493344844811",
        }
     */
    ctx.body = ctx.response.headers;
});

app.listen(3000);

set header

const serverTimestamp = require('./');
const Koa = require('koa');
const app = new Koa();

app.use(serverTimestamp({header: 'Example-Server-Timestamp'}));

// response
app.use(ctx => {
    /*
       Body results:
       {
          "example-server-timestamp": "1493344844812",
       }
    */
    ctx.body = ctx.response.headers;
});

app.listen(3000);

set header and format

const serverTimestamp = require('./');
const Koa = require('koa');
const app = new Koa();

app.use(serverTimestamp({
    header: 'Example-Format-Server-Timestamp',
    format: (timestamp) => {
        let now = new Date(timestamp);
        let year = now.getFullYear();
        let month = now.getMonth() + 1;
        let date = now.getDate();
        let hour = now.getHours();
        let minute = now.getMinutes();
        let second = now.getSeconds();

        return `${year}-${month}-${date} ${hour}:${minute}:${second}`;
    }
}));

// response
app.use(ctx => {
    /*
       Body results:
       {
         "example-format-server-timestamp": "2017-4-28 10:3:44",
       }
    */
    ctx.body = ctx.response.headers;
});

app.listen(3000);

Full Example

Check this repo for full example with Koa v2.

License

MIT

sunilwang / koa-server-timestamp Goto Github PK