bun-routes/dist/route.d.ts

Bun Routes is a lightweight, type-safe router built for Bun with zero dependencies

import type { RouterTypes } from "bun";
import { type Middleware } from "./middleware";
/**
 * Options for creating a route.
 *
 * @template T - The route path type, which may include dynamic parameters.
 */
export interface RouteOptions<T extends string> {
    /**
     * Indicates whether the route should be exposed.
     * Defaults to true. If false, the route will return a default 404 response.
     */
    expose?: boolean;
    /**
     * The HTTP method for the route.
     * This must be one of the supported methods defined in RouterTypes.
     */
    method: RouterTypes.HTTPMethod;
    /**
     * The path for the route.
     * This can include dynamic parameters (e.g., "/users/:id").
     */
    path: T;
    /**
     * An optional array of middleware functions to execute before the route handler.
     */
    middlewares?: readonly Middleware<`${string}`>[];
}
/**
 * Creates a route tuple with the provided options and final handler.
 * If the route is not exposed, returns a default 404 handler.
 *
 * @param options - Route configuration options.
 * @param handler - The final route handler.
 * @returns A tuple containing the route path and a RouteHandlerObject.
 */
export declare function route<T extends string>(options: RouteOptions<T>, handler: RouterTypes.RouteHandler<T>): [T, RouterTypes.RouteHandlerObject<T>];