Skip to content

floatdrop/express-request-id

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Oct 5, 2022
ff8e6b7 · Oct 5, 2022

History

39 Commits
Jan 16, 2022
Jan 14, 2022
Jan 14, 2022
Jan 14, 2022
Jan 14, 2022
Jan 14, 2022
Jan 14, 2022
Oct 5, 2022
Jan 16, 2022
Jan 14, 2022
Oct 5, 2022

Repository files navigation

express-request-id

Tests npm version npm downloads

Generates UUID for request and add it to header.

Install

npm install express-request-id

Usage

import express from 'express';
import requestID from 'express-request-id';

app.use(requestID());

app.get('/', function (req, res, next) {
    res.send(req.id);
    next();
});

app.listen(3000, function() {
    console.log('Listening on port %d', server.address().port);
});

// curl localhost:3000
// d7c32387-3feb-452b-8df1-2d8338b3ea22

API

requestID(options?)

options

Type: object

generator

Type: function Default: func(req) { return uuidv4(); }

Defines function, that generated ID from request. By default used uuid module, that generated UUID V4 for every request.

headerName

Type: string Default: X-Request-Id

Defines name of header, that should be used for request ID checking and setting.

setHeader

Type: bool Default: true

If false – header will not be set.