1.0.1 • Published 4 years ago

node-express-req-id v1.0.1

Weekly downloads
157
License
MIT
Repository
github
Last release
4 years ago

node-express-req-id

NPM version express-req-id Coverage Status

  • Generate CUID / UUID for express request and add it to X-Request-Id header.
  • In case request contains X-Request-Id header, uses its value instead.
  • By default identifer value is added to response header

Quickstart

1. Install

$ npm install --save node-express-req-id

2. Example

var express       = require('express');
var app           = express();
var expressreqid  = require('node-express-req-id')({
  type: 'cuid'  // `uuid` or `cuid`
});

app.use(expressreqid);

app.listen(3001, () => {
  console.log('Server running on port 3001');
});


app.get('/test', (req, res, next) => {
  res.send(req.id).status(200);
});

// UUID v4
// curl localhost:3001/test
// 5257f2f6-d826-4e57-8bcd-bcec01dac732

// CUID
// curl localhost:3001/test
// ckdjyjj9200008se21jd9dy4z

API

node-express-req-id(options)

Returns either uuid or cuid middleware and appends to request object

Options

typeSpecifies type of identifier uuid or cuidrequired
headerKeyCustom key to be used in requestdefault id
headerNameExisting reference of key in request body to be useddefault X-Request-Id
uuidVersionRFC version to be used by uuiddefault v4

License

The node-express-req-id is licensed under the MIT License. See LICENSE for more information.