remix-utils/build/server/middleware/server-timing.d.ts

This package contains simple utility functions to use with [React Router](https://reactrouter.com/).

/**
 * > This depends on `@edgefirst-dev/server-timing`.
 * The server timing middleware let's you add a `Server-Timing` header to the response with the time it took to run the loaders and actions.
 *
 * ```ts
 * import { unstable_createServerTimingMiddleware } from "remix-utils/middleware/server-timing";
 *
 * export const [serverTimingMiddleware, getTimingCollector] =
 *   unstable_createServerTimingMiddleware();
 * ```
 *
 * To use it, you need to add it to the `unstable_middleware` array in your `app/root.tsx` file.
 *
 * ```ts
 * import { serverTimingMiddleware } from "~/middleware/server-timing.server";
 *
 * export const unstable_middleware = [serverTimingMiddleware];
 * ```
 *
 * And you can use the `getTimingCollector` function in your loaders and actions to add timings to the response.
 *
 * ```ts
 * import { getTimingCollector } from "~/middleware/server-timing.server";
 *
 * export async function loader({ request }: LoaderFunctionArgs) {
 *   let collector = getTimingCollector();
 *   return await collector.measure("name", "optional description", async () => {
 *     return await getData();
 *   });
 * }
 * ```
 *
 * The `measure` function will measure the time it took to run the function passed as the last argument and add it to the `Server-Timing` header.
 * @author [Sergio Xalambrí](https://sergiodxa.com)
 * @module Middleware/Server Timing
 */
import { TimingCollector } from "@edgefirst-dev/server-timing";
import type { unstable_MiddlewareFunction } from "react-router";
import type { unstable_MiddlewareGetter } from "./utils.js";
/**
 * Create a middleware that gives you access to a `TimingCollector` instance,
 * used to collect server timing metrics and report them in the response
 * headers.
 *
 * The reported metrics will be available in the browser's developer tools.
 *
 * @returns A tuple with the middleware function and a function to get the
 * `TimingCollector` instance from the context.
 * @example
 * import { unstable_createServerTimingMiddleware } from "remix-utils/middleware/server-timing";
 *
 * const [serverTimingMiddleware, getTimingCollector] = unstable_createServerTimingMiddleware();
 *
 * export const unstable_middleware = [serverTimingMiddleware];
 *
 * export async function loader({ context }: Route.LoaderArgs) {
 *  let collector = getTimingCollector(context);
 *  return await collector.measure("name", "optional description", () => {
 *    return getData();
 *  });
 * }
 */
export declare function unstable_createServerTimingMiddleware(): unstable_createServerTimingMiddleware.ReturnType;
export declare namespace unstable_createServerTimingMiddleware {
    /**
     * The return type of `unstable_createServerTimingMiddleware`.
     */
    type ReturnType = [
        unstable_MiddlewareFunction<Response>,
        unstable_MiddlewareGetter<TimingCollector>
    ];
}
export declare const serverTimingMiddleware: unstable_MiddlewareFunction<Response>, getTimingCollector: unstable_MiddlewareGetter<TimingCollector>;