tezx/core/server.d.ts

TezX is a high-performance, lightweight JavaScript framework designed for speed, scalability, and flexibility. It enables efficient routing, middleware management, and static file serving with minimal configuration. Fully compatible with Node.js, Deno, an

import { ConnAddress, HTTPMethod, Middleware } from "../types/index.js";
import { Context } from "./context.js";
import { Router, RouterConfig } from "./router.js";
export type TezXServeOptions = {
    connInfo: ConnAddress;
};
export type TezXConfig = {
    /**
     * `allowDuplicateMw` determines whether duplicate middleware functions
     * are allowed in the router.
     *
     * - When `true`: The same middleware can be added multiple times.
     * - When `false`: Ensures each middleware is registered only once
     *   per route or application context.
     *
     * @default false
     */
    allowDuplicateMw?: boolean;
    /**
     * `overwriteMethod` controls whether existing route handlers
     * should be overwritten when a new handler for the same
     * HTTP method and path is added.
     *
     * - When `true`: The new handler replaces the existing one.
     * - When `false`: Prevents overwriting, ensuring that the
     *   first registered handler remains active.
     *
     * @default true
     */
    overwriteMethod?: boolean;
    /**
     * 🔄 Hook to transform or normalize the incoming request pathname before routing.
     *
     * This function allows you to customize how incoming paths are handled.
     * You can use it to:
     * - Remove trailing slashes
     * - Normalize casing
     * - Rewrite certain paths dynamically
     * - Add localization or versioning prefixes
     *
     * @example
     * ```ts
     * onPathResolve: (pathname) => pathname.replace(/\/+$/, "").toLowerCase()
     * ```
     *
     * @param pathname - The raw incoming request path (e.g., `/Api/Users/`)
     * @returns The transformed or resolved path used for routing (e.g., `/api/users`)
     */
    onPathResolve?: (pathname: string) => string;
    /**
     * Enables or disables debugging for the middleware.
     * When set to `true`, detailed debug logs will be output,
     * useful for tracking the flow of requests and identifying issues.
     *
     * @default false
     */
    debugMode?: boolean;
} & RouterConfig;
export declare class TezX<T extends Record<string, any> = {}> extends Router<T> {
    #private;
    constructor({ basePath, env, debugMode, onPathResolve, allowDuplicateMw, overwriteMethod, }?: TezXConfig);
    protected findRoute(method: HTTPMethod, pathname: string): {
        callback: any;
        middlewares: Middleware<T>[];
        params: Record<string, null | string>;
    } | null;
    serve(req: Request, options: TezXServeOptions): Promise<Response | {
        websocket: (props: any) => any;
        ctx: Context;
    }>;
}