TanTan
2a69b23b47
Dev Build / cleanup (push) Canceled after 0s
Dev Build / typecheck (push) Canceled after 0s
Dev Build / build (linux-arm64, ubuntu-24.04-arm, linux-arm64) (push) Canceled after 0s
Dev Build / build (linux-x64, ubuntu-latest, linux-x64) (push) Canceled after 0s
Dev Build / build (win-x64, windows-latest, win32-x64) (push) Canceled after 0s
Dev Build / dispatch-dev-docker (push) Skipped
35 lines
1.1 KiB
Plaintext
35 lines
1.1 KiB
Plaintext
import { MiddlewareHandler } from "../../types.js";
|
|
import { Context } from "../../context.js";
|
|
//#region src/middleware/request-id/request-id.d.ts
|
|
export type RequestIdVariables = {
|
|
requestId: string;
|
|
};
|
|
export type RequestIdOptions = {
|
|
limitLength?: number;
|
|
headerName?: string;
|
|
generator?: (c: Context) => string;
|
|
};
|
|
/**
|
|
* Request ID Middleware for Hono.
|
|
*
|
|
* @param {object} options - Options for Request ID middleware.
|
|
* @param {number} [options.limitLength=255] - The maximum length of request id.
|
|
* @param {string} [options.headerName=X-Request-Id] - The header name used in request id.
|
|
* @param {generator} [options.generator=() => crypto.randomUUID()] - The request id generation function.
|
|
*
|
|
* @returns {MiddlewareHandler} The middleware handler function.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* type Variables = RequestIdVariables
|
|
* const app = new Hono<{Variables: Variables}>()
|
|
*
|
|
* app.use(requestId())
|
|
* app.get('/', (c) => {
|
|
* console.log(c.get('requestId')) // Debug
|
|
* return c.text('Hello World!')
|
|
* })
|
|
* ```
|
|
*/
|
|
export declare const requestId: ({ limitLength, headerName, generator }?: RequestIdOptions) => MiddlewareHandler;
|
|
//#endregion |