Needless Patchouli Manufacture

    express-request-id
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    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.

    Install

    npm i express-request-id

    DownloadsWeekly Downloads

    68,525

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    3.77 kB

    Total Files

    4

    Last publish

    Collaborators

    • floatdrop