remix-utils
Version:
This package contains simple utility functions to use with [React Router](https://reactrouter.com/).
30 lines (29 loc) • 996 B
TypeScript
import type { unstable_MiddlewareFunction } from "react-router";
import { unstable_RouterContextProvider } from "react-router";
export declare function unstable_createRequestIDMiddleware({ generator, header, limitLength, }?: unstable_createRequestIDMiddleware.Options): unstable_createRequestIDMiddleware.ReturnType;
export declare namespace unstable_createRequestIDMiddleware {
interface Options {
/**
* The name of the header to read the request ID from.
*
* @default "X-Request-ID"
*/
header?: string;
/**
* The length of the request ID.
*
* @default 255
*/
limitLength?: number;
/**
* A function to generate a request ID.
*
* @default () => crypto.randomUUID()
*/
generator?(): string;
}
type ReturnType = [
unstable_MiddlewareFunction<Response>,
(context: unstable_RouterContextProvider) => string
];
}