@tanstack/router-plugin
Version:
Modern and scalable routing for React applications
164 lines (163 loc) • 6.22 kB
text/typescript
import { configSchema, Config } from './core/config.cjs';
/**
* @example
* ```ts
* export default {
* // ...
* plugins: [TanStackRouterGeneratorWebpack()],
* }
* ```
*/
declare const TanStackRouterGeneratorWebpack: (options?: Partial<{
target: "react" | "solid";
routeFileIgnorePrefix: string;
routesDirectory: string;
quoteStyle: "single" | "double";
semicolons: boolean;
disableLogging: boolean;
routeTreeFileHeader: string[];
indexToken: string;
routeToken: string;
generatedRouteTree: string;
disableTypes: boolean;
addExtensions: boolean;
enableRouteTreeFormatting: boolean;
routeTreeFileFooter: string[];
tmpDir: string;
enableRouteGeneration?: boolean | undefined;
codeSplittingOptions?: import('./core/config.cjs').CodeSplittingOptions | undefined;
virtualRouteConfig?: string | import('@tanstack/virtual-file-routes').VirtualRootRoute | undefined;
routeFilePrefix?: string | undefined;
routeFileIgnorePattern?: string | undefined;
pathParamsAllowedCharacters?: (";" | ":" | "@" | "&" | "=" | "+" | "$" | ",")[] | undefined;
verboseFileRoutes?: boolean | undefined;
autoCodeSplitting?: boolean | undefined;
customScaffolding?: {
routeTemplate?: string | undefined;
lazyRouteTemplate?: string | undefined;
} | undefined;
experimental?: {
enableCodeSplitting?: boolean | undefined;
} | undefined;
plugins?: import('@tanstack/router-generator').GeneratorPlugin[] | undefined;
}> | undefined) => import('unplugin').WebpackPluginInstance;
/**
* @example
* ```ts
* export default {
* // ...
* plugins: [TanStackRouterCodeSplitterWebpack()],
* }
* ```
*/
declare const TanStackRouterCodeSplitterWebpack: (options?: Partial<{
target: "react" | "solid";
routeFileIgnorePrefix: string;
routesDirectory: string;
quoteStyle: "single" | "double";
semicolons: boolean;
disableLogging: boolean;
routeTreeFileHeader: string[];
indexToken: string;
routeToken: string;
generatedRouteTree: string;
disableTypes: boolean;
addExtensions: boolean;
enableRouteTreeFormatting: boolean;
routeTreeFileFooter: string[];
tmpDir: string;
enableRouteGeneration?: boolean | undefined;
codeSplittingOptions?: import('./core/config.cjs').CodeSplittingOptions | undefined;
virtualRouteConfig?: string | import('@tanstack/virtual-file-routes').VirtualRootRoute | undefined;
routeFilePrefix?: string | undefined;
routeFileIgnorePattern?: string | undefined;
pathParamsAllowedCharacters?: (";" | ":" | "@" | "&" | "=" | "+" | "$" | ",")[] | undefined;
verboseFileRoutes?: boolean | undefined;
autoCodeSplitting?: boolean | undefined;
customScaffolding?: {
routeTemplate?: string | undefined;
lazyRouteTemplate?: string | undefined;
} | undefined;
experimental?: {
enableCodeSplitting?: boolean | undefined;
} | undefined;
plugins?: import('@tanstack/router-generator').GeneratorPlugin[] | undefined;
}> | undefined) => import('unplugin').WebpackPluginInstance;
/**
* @example
* ```ts
* export default {
* // ...
* plugins: [tanstackRouter()],
* }
* ```
*/
declare const TanStackRouterWebpack: (options?: Partial<{
target: "react" | "solid";
routeFileIgnorePrefix: string;
routesDirectory: string;
quoteStyle: "single" | "double";
semicolons: boolean;
disableLogging: boolean;
routeTreeFileHeader: string[];
indexToken: string;
routeToken: string;
generatedRouteTree: string;
disableTypes: boolean;
addExtensions: boolean;
enableRouteTreeFormatting: boolean;
routeTreeFileFooter: string[];
tmpDir: string;
enableRouteGeneration?: boolean | undefined;
codeSplittingOptions?: import('./core/config.cjs').CodeSplittingOptions | undefined;
virtualRouteConfig?: string | import('@tanstack/virtual-file-routes').VirtualRootRoute | undefined;
routeFilePrefix?: string | undefined;
routeFileIgnorePattern?: string | undefined;
pathParamsAllowedCharacters?: (";" | ":" | "@" | "&" | "=" | "+" | "$" | ",")[] | undefined;
verboseFileRoutes?: boolean | undefined;
autoCodeSplitting?: boolean | undefined;
customScaffolding?: {
routeTemplate?: string | undefined;
lazyRouteTemplate?: string | undefined;
} | undefined;
experimental?: {
enableCodeSplitting?: boolean | undefined;
} | undefined;
plugins?: import('@tanstack/router-generator').GeneratorPlugin[] | undefined;
}> | undefined) => import('unplugin').WebpackPluginInstance;
declare const tanstackRouter: (options?: Partial<{
target: "react" | "solid";
routeFileIgnorePrefix: string;
routesDirectory: string;
quoteStyle: "single" | "double";
semicolons: boolean;
disableLogging: boolean;
routeTreeFileHeader: string[];
indexToken: string;
routeToken: string;
generatedRouteTree: string;
disableTypes: boolean;
addExtensions: boolean;
enableRouteTreeFormatting: boolean;
routeTreeFileFooter: string[];
tmpDir: string;
enableRouteGeneration?: boolean | undefined;
codeSplittingOptions?: import('./core/config.cjs').CodeSplittingOptions | undefined;
virtualRouteConfig?: string | import('@tanstack/virtual-file-routes').VirtualRootRoute | undefined;
routeFilePrefix?: string | undefined;
routeFileIgnorePattern?: string | undefined;
pathParamsAllowedCharacters?: (";" | ":" | "@" | "&" | "=" | "+" | "$" | ",")[] | undefined;
verboseFileRoutes?: boolean | undefined;
autoCodeSplitting?: boolean | undefined;
customScaffolding?: {
routeTemplate?: string | undefined;
lazyRouteTemplate?: string | undefined;
} | undefined;
experimental?: {
enableCodeSplitting?: boolean | undefined;
} | undefined;
plugins?: import('@tanstack/router-generator').GeneratorPlugin[] | undefined;
}> | undefined) => import('unplugin').WebpackPluginInstance;
export default TanStackRouterWebpack;
export { configSchema, TanStackRouterWebpack, TanStackRouterGeneratorWebpack, TanStackRouterCodeSplitterWebpack, tanstackRouter, };
export type { Config };