fastify-file-router/dist/FastifyFileRouterOptions.d.ts

A fastify plugin that automatically registers routes from files in a directory.

import type { LogLevel } from 'fastify';
export type FileRouteConvention = 'remix' | 'next';
export type FastifyFileRouterProfileOptions = {
    /**
     * Enable startup profiling logs for route discovery and registration.
     * @default false
     */
    enabled?: boolean;
    /**
     * Log each route file timing in addition to the startup summary.
     * @default false
     */
    logIndividualRoutes?: boolean;
    /**
     * Number of slowest route files to print in the summary.
     * @default 10
     */
    slowestRoutesCount?: number;
};
export type FastifyFileRouterOptions = {
    /**
     * Where the routes should be mounted on the server.
     * @default "/"
     */
    mount?: string;
    /**
     * The local directory where the routes are located relative to the build root folder.
     * @default ["./routes", "./src/routes"]
     */
    routesDirs?: string[];
    /**
     * The root folder of the source code that should be loaded. If you are transpiling your source code,
     * you should set this to the build output directory, e.g. 'dist' or 'build'.
     * @default '.' (current working directory)
     */
    buildRoot?: string;
    /**
     * The file extension for the route files.
     * @default [".js", ".ts", ".jsx", ".tsx"]
     */
    extensions?: string[];
    /**
     * File convention for the route files, can be either "remix" or "next".
     * @default "remix"
     */
    convention?: FileRouteConvention;
    /**
     * Verbosity level for the plugin.
     * @default "info"
     */
    logLevel?: LogLevel;
    /**
     * Whether to log routes to the console.
     * @default false
     */
    logRoutes?: boolean;
    /**
     * Whether to enable validation of Zod response schemas.
     * When enabled, responses defined with Zod schemas in defineRouteZod will be validated.
     * Note: This only validates Zod response schemas. For JSON Schema response validation,
     * register the @fastify/response-validation plugin separately.
     * @default false
     */
    zodResponseValidation?: boolean;
    /**
     * Exclusion patterns for files to ignore.
     */
    exclude?: RegExp[];
    /**
     * Max number of route loading tasks that may run concurrently.
     * Higher values can increase startup throughput but may spike CPU and I/O.
     * @default 4
     */
    maxConcurrentTasks?: number;
    /**
     * Startup profiling options for route discovery/import/registration.
     */
    profile?: FastifyFileRouterProfileOptions;
};
//# sourceMappingURL=FastifyFileRouterOptions.d.ts.map