requestID

Middleware for assigning a unique request ID to every incoming HTTP request. Useful for request tracking, logging, and debugging.

Import

import { requestID } from "tezx/middleware";

Parameters

const requestID = (
  headerName: string = "X-Request-ID",
  contextKey: string = "requestID",
): Middleware => { ... }

Parameter	Type	Default	Description
`headerName`	`string`	`"X-Request-ID"`	The HTTP header to store the request ID.
`contextKey`	`string`	`"requestID"`	Key to store the request ID in the TezX context (`ctx`).

Behavior

Checks if the incoming request already has the request ID header.
If not present, generates a new unique ID using generateUUID().
Sets the request ID in:
- HTTP header (ctx.headers.set(headerName, requestId))
- TezX context (ctx[contextKey] = requestId)
Can be accessed by downstream middleware or handlers using ctx[contextKey].

Usage

Basic Usage

import { requestID } from "tezx/middleware";

app.use(requestID());

// Access request ID in a route
router.get("/api/data", async (ctx) => {
  console.log("Request ID:", ctx.requestID);
  return ctx.json({ requestID: ctx.requestID });
});

Adds header:

X-Request-ID: req-<unique-id>

Custom Header Name

app.use(requestID("X-Custom-Request-ID"));

Sets the request ID in X-Custom-Request-ID header and context key requestID:

ctx.requestID // contains the generated ID

Custom Context Key

app.use(requestID("X-Request-ID", "reqId"));

// Access in route
router.get("/api/data", async (ctx) => {
  console.log(ctx.reqId); // custom context key
  return ctx.json({ reqId: ctx.reqId });
});

Middleware Type

function requestID(headerName?: string, contextKey?: string): Middleware

Returns a Middleware function compatible with TezX.
Can be used globally or per-route.

Example with Logger Integration

import {requestID,logger} from "tezx/middleware";

app.use(requestID()); // assign request ID
app.use(logger());    // log requests including request ID

app.get("/api/users", async (ctx) => {
  return ctx.json({ requestID: ctx.requestID });
});

Each log can include the unique request ID for traceability.

requestID

On this page