rasengan/lib/types/routing/utils/generate-routes.d.ts

The modern React Framework

import { RouterComponent } from '../interfaces.js';
import { RouteObject } from '../types.js';
/**
 * This function preload the matching lazy routes
 * @param url
 * @param routes
 */
export declare const preloadMatches: (url: Partial<Location> | string, routes: RouteObject[]) => Promise<void>;
/**
 * This function receives a router component and return a formated router for static routing
 * @param router Represents the router component
 * @returns
 */
export declare const generateRoutes: (router: RouterComponent, isRoot?: boolean, parentLayoutPath?: string | undefined) => RouteObject[];
/**
 * Recursively extract all full paths from a nested routes tree,
 * including index routes.
 */
export declare function getAllRoutesPath(routes: RouteObject[], parentPath?: string): Promise<{
    paths: string[];
    error: Set<string>;
}>;
/**
 * This function receives a router component and return a mapping from path to metadata
 * @param router Represents the router component
 * @returns
 */