API reference

API reference

Find public import paths, application factory APIs, and compatible dependency versions.

Effront separates application APIs from host adapters and build integrations. Use @effront/core to define pages, routes, services, and Server Functions. Choose the other packages for hosting, Markdown, or styling.

Public API map

Import pathMain APIsReference
@effront/coreApplication, PageViewTransitionApplication, components
@effront/core/httptoHttpEffect, makeHttpEffectNative HTTP
@effront/core/workerscreateFetchHandler, WorkersRequestContext, context readersFetch and Workers context
@effront/cloudflare/workersCloudflareExecutionContext, Cloudflare context readersFetch and Workers context
@effront/server/nodeNode.js serveNode.js / Bun server
@effront/server/bunBun serveNode.js / Bun server
@effront/server/assetswithAssetsNode.js / Bun server
@effront/alchemy/cloudflareapplicationHttpEffect, makeApplicationHttpEffectAlchemy
@effront/viteeffront, EffrontViteOptionsVite and Cloudflare plugins
@effront/cloudflareeffrontCloudflare, EffrontCloudflareOptionsVite and Cloudflare plugins
@effront/server/viteeffrontServerNode.js / Bun server
@effront/alchemy/cloudflare/viteeffrontAlchemyAlchemy
@effront/markdowncreateMarkdownCollection, parseMarkdown, MarkdownErrorMarkdown
@effront/tailwindeffrontTailwindTailwind
@effront/markdown/documentMarkdownDocument, MarkdownDocumentPropsMarkdown
@effront/markdown/mathMathMarkdown
@effront/markdown/mermaidMermaidMarkdown

| @effront/core/query | query, queryAtom, stream, streamAtom, typed Server Function errors | Query Server Functions, Stream Server Functions |

Runtime imports from @effront/core require the react-server condition. Keep them in the application graph configured by effront(), not in a host process with react-server enabled globally. For application setup, see Getting started and Platforms.

Application factory index

Application.effront<Services>() returns these factories and methods. Related definitions must share one factory instance or a derivative from withMiddleware.

MemberResultReference
Component, Page, Layout, LoadingRendered content and route UI definitionsComponents
Routes, MiddlewareRoute groups and scoped request middlewareRoutes and Middleware
ServerFnSchema-validated Server FunctionsServerFn
withMiddlewareDerived factories with additional middleware and the same application identityApplication
makeAn application definition, not a running serverApplication

Dependency matrix

Package or package familyVersion
All Effront packages0.2.0
react, react-dom19.3.0
@vitejs/plugin-rsc0.5.35
effect, @effect/platform-browser, host-specific Effect packages4.0.0-rc.116
alchemy2.0.0-beta.79
@comark/react0.6.2

Keep Effront package versions aligned, including optional adapters and integrations. React and React DOM must match, and @vitejs/plugin-rsc@0.5.35 includes the matching 19.3.0 RSC transport. ViewTransition and addTransitionType are stable React 19.3.0 APIs. Keep Effect family versions aligned as well. Vite integrations declare a public Vite peer dependency of *. The setup guides use VitePlus.