@vortex-js/core/dist/core/Routes.d.ts

A simple and powerful role-based access control (RBAC) middleware for Express.js, designed to be easy to use and integrate with your existing applications. It provides a flexible way to manage user permissions and roles, making it ideal for building secur

import { Router, Handler } from "express";
import Route from "./Route";
import ErrorRoute from "./ErrorRoute";
import { IRoutes, Param } from "../types";
import { PostmanRouteItem } from "../types/postman";
import Module from "./Module";
declare class Routes<T = any> {
    module?: Module<T>;
    prefix: string;
    error?: ErrorRoute;
    routes: Array<Route | Routes>;
    params?: Param[];
    middlewares?: Handler[];
    postman?: {
        folderName: string;
    };
    constructor(r: IRoutes);
    registerModule(module: Module<T>): void;
    buildRouter(p_router?: Router, p_prefix?: {
        path: string;
    }): Router;
    private handleParams;
    /**
     * Generates a routes folder structure and processes all routes recursively.
     *
     * This function creates a routes folder if createFolder is true and processes
     * all routes by either:
     * - Calling generateFolder() if the route is an instance of Routes
     * - Calling generateRoute() if the route is an instance of Route
     *
     * @param pathPrefix - The prefix to prepend to the current path. Defaults to an empty string.
     * @returns Either a folder object containing route items or a flat array of route items
     * @throws Error if an invalid route type is encountered
     */
    generateFolder(pathPrefix?: string): PostmanRouteItem[] | PostmanRouteItem;
}
export default Routes;