Reference
@reckona/mreact-router/adapters/cloudflare
33 public exports.
Function
FunctioncloudflareClientAssetPaths
function cloudflareClientAssetPaths(manifest: CloudflareClientManifest, options: { extraPaths?: readonly string[]; prefix?: string }): Set<string>Returns the set of client and public asset paths a Cloudflare Worker is allowed to serve.FunctioncollectCloudflareRouteModulesfunction collectCloudflareRouteModules<Env>(glob: CloudflareRouteModuleGlob<Env>, options: CollectCloudflareRouteModulesOptions): CloudflareRouteModuleRegistry<Env>Validates and normalizes a Vite `import.meta.glob` map into a Cloudflare route module registry. Every manifest route that needs a module must be present, and extra glob entries are rejected to catch stale generated workers.FunctioncreateCloudflareBuiltRequestHandlerfunction createCloudflareBuiltRequestHandler<Env>(options: CloudflareBuiltRequestHandlerOptions<Env>): CloudflareRequestHandler<Env>Creates a Cloudflare Worker handler that matches built app-router routes before rendering. Pair it with `createCloudflareRouteModuleRenderer()` and the generated route module registry from Cloudflare-target builds.FunctioncreateCloudflarePrerenderStorefunction createCloudflarePrerenderStore(options: CloudflarePrerenderStoreOptions): AppRouterPrerenderStoreCreates an app-router prerender store backed by the Cloudflare Cache API. Keys are represented as synthetic requests so Workers cache entries can be shared by path and optional key prefix.FunctioncreateCloudflareRequestHandlerfunction createCloudflareRequestHandler<Env>(options: CloudflareRequestHandlerOptions<Env>): CloudflareRequestHandler<Env>Creates a Cloudflare Worker `fetch` handler from manifests, asset loading, and an optional renderer. The handler serves generated client assets and prerendered routes before calling `render`, preserves streamed HTML responses, and routes errors through `onError` when provided.FunctioncreateCloudflareRouteModuleRendererfunction createCloudflareRouteModuleRenderer<Env>(options: CloudflareRouteModuleRendererOptions<Env>): (request: Request, context: CloudflareBuiltRouteRenderContext<Env>): Response | Promise<Response>Creates the renderer used by the generated Cloudflare Worker route registry. It loads matched route modules, dispatches server route handlers, evaluates loaders and metadata, and renders page routes with Cloudflare request context.FunctioncreateCloudflareStaticAssetLoaderfunction createCloudflareStaticAssetLoader<Env>(options: CloudflareStaticAssetLoaderOptions<Env>): CloudflareAssetLoader<Env>Creates a Cloudflare asset loader that forwards only manifest-listed client and public asset paths. This keeps the Worker from passing arbitrary paths to the `ASSETS` binding while still serving generated route scripts, CSS, imports, source maps, and allowed public files.Interface
InterfaceCloudflareAssetBinding
interface CloudflareAssetBindingRepresents a Cloudflare asset binding with a `fetch` method.InterfaceCloudflareAssetLoaderinterface CloudflareAssetLoaderLoads static assets for Cloudflare router requests.InterfaceCloudflareBuiltRequestHandlerOptionsinterface CloudflareBuiltRequestHandlerOptionsConfigures a Cloudflare request handler that renders matched built routes.InterfaceCloudflareBuiltRouteRenderContextinterface CloudflareBuiltRouteRenderContextProvides route match data to Cloudflare built-route rendering.InterfaceCloudflareCacheinterface CloudflareCacheDefines the Cloudflare Cache API subset used by prerender stores.InterfaceCloudflareClientManifestinterface CloudflareClientManifestDescribes client assets and route metadata used by Cloudflare handlers.InterfaceCloudflareExecutionContextinterface CloudflareExecutionContextRepresents the Cloudflare Worker execution context used by router handlers.InterfaceCloudflareMetadataRouteContextinterface CloudflareMetadataRouteContextProvides request context to Cloudflare metadata route modules.InterfaceCloudflareMetadataRouteModuleinterface CloudflareMetadataRouteModuleDefines the default export accepted from a Cloudflare metadata route module.InterfaceCloudflarePrerenderStoreOptionsinterface CloudflarePrerenderStoreOptionsConfigures a Cloudflare Cache API backed prerender store.InterfaceCloudflareRenderContextinterface CloudflareRenderContextProvides manifests, environment, and execution context to Cloudflare rendering.InterfaceCloudflareRequestHandlerinterface CloudflareRequestHandlerDefines the Cloudflare Worker `fetch` handler shape returned by router adapters.InterfaceCloudflareRequestHandlerOptionsinterface CloudflareRequestHandlerOptionsConfigures a Cloudflare Worker request handler for app-router output.InterfaceCloudflareRouteModuleinterface CloudflareRouteModuleDefines the exports accepted from a Cloudflare page route module.InterfaceCloudflareRouteModuleComponentPropsinterface CloudflareRouteModuleComponentPropsProvides props to Cloudflare route module components.InterfaceCloudflareRouteModuleLoaderContextinterface CloudflareRouteModuleLoaderContextProvides loader context to Cloudflare route modules.InterfaceCloudflareRouteModuleRendererOptionsinterface CloudflareRouteModuleRendererOptionsConfigures the Cloudflare route module renderer.InterfaceCloudflareServerRouteContextinterface CloudflareServerRouteContextProvides request context to Cloudflare server route handlers.InterfaceCloudflareServerRouteModuleinterface CloudflareServerRouteModuleDefines HTTP method exports accepted from a Cloudflare server route module.InterfaceCloudflareStaticAssetLoaderOptionsinterface CloudflareStaticAssetLoaderOptionsConfigures static asset loading from a Cloudflare asset binding.InterfaceCollectCloudflareRouteModulesOptionsinterface CollectCloudflareRouteModulesOptionsConfigures collection of Cloudflare route modules from a built manifest.Type Alias
Type AliasCloudflareRouteModuleComponent
type CloudflareRouteModuleComponent = (props: CloudflareRouteModuleComponentProps<Data, Env>): Response | string | PromiseLike<Response | string>Renders a Cloudflare route module response body or `Response`.Type AliasCloudflareRouteModuleGlobtype CloudflareRouteModuleGlob = Record<string, CloudflareRouteModuleRegistryEntry<Env> | (): CloudflareRouteModuleRegistryEntry<Env> | PromiseLike<CloudflareRouteModuleRegistryEntry<Env>>>Represents an import glob of Cloudflare route modules.Type AliasCloudflareRouteModuleRegistrytype CloudflareRouteModuleRegistry = Record<string, CloudflareRouteModuleRegistryEntry<Env> | (): CloudflareRouteModuleRegistryEntry<Env> | PromiseLike<CloudflareRouteModuleRegistryEntry<Env>>>Maps generated route module file keys to Cloudflare route modules or lazy loaders.Type AliasCloudflareRouteModuleRegistryEntrytype CloudflareRouteModuleRegistryEntry = CloudflareRouteModule<unknown, Env> | CloudflareMetadataRouteModule | CloudflareServerRouteModule<Env>Represents one registered Cloudflare route module entry.Type AliasCloudflareServerRouteHandlertype CloudflareServerRouteHandler = (request: Request, context: CloudflareServerRouteContext<Env>): unknown | PromiseLike<unknown>Handles a Cloudflare server route request.