file-router-react
Version:
File-based routing for React using wouter.
35 lines (34 loc) • 1.16 kB
TypeScript
import { RouteConfig } from "./types";
/**
* Create routes from Vite's import.meta.glob.
*
* @param modules - The result from import.meta.glob
* @returns Array of route configurations
*
* @example
* ```typescript
* import { createViteRoutes, FileRouter } from 'file-router-react';
*
* const modules = import.meta.glob('./pages/**\/*.{tsx,jsx}', { eager: true });
* const routes = createViteRoutes(modules);
*
* function App() {
* return <FileRouter routes={routes} />;
* }
* ```
*/
export declare function createViteRoutes(modules: Record<string, any>): RouteConfig[];
/**
* Create routes from webpack's require.context.
*
* @param requireContext - The webpack require.context result
* @returns Array of route configurations
*/
export declare function createWebpackRoutes(requireContext: __WebpackModuleApi.RequireContext): RouteConfig[];
/**
* Auto-detect and create routes based on your bundler environment.
*
* @param viteModules - Optional: result from import.meta.glob for Vite projects
* @returns Array of route configurations
*/
export declare function createFileRoutes(viteModules?: Record<string, any>): RouteConfig[];