- Generate CUID / UUID for express request and add it to
X-Request-Idheader. - In case request contains
X-Request-Idheader, uses its value instead. - By default identifer value is added to response header
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
// ckdjyjj9200008se21jd9dy4zReturns either uuid or cuid middleware and appends to request object
| type | Specifies type of identifier uuid or cuid |
required |
| headerKey | Custom key to be used in request | default id |
| headerName | Existing reference of key in request body to be used | default X-Request-Id |
| uuidVersion | RFC version to be used by uuid | default v4 |
The node-express-req-id is licensed under the MIT License. See LICENSE for more information.