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 path | Main APIs | Reference |
|---|---|---|
@effront/core | Application, PageViewTransition | Application, components |
@effront/core/http | toHttpEffect, makeHttpEffect | Native HTTP |
@effront/core/workers | createFetchHandler, WorkersRequestContext, context readers | Fetch and Workers context |
@effront/cloudflare/workers | CloudflareExecutionContext, Cloudflare context readers | Fetch and Workers context |
@effront/server/node | Node.js serve | Node.js / Bun server |
@effront/server/bun | Bun serve | Node.js / Bun server |
@effront/server/assets | withAssets | Node.js / Bun server |
@effront/alchemy/cloudflare | applicationHttpEffect, makeApplicationHttpEffect | Alchemy |
@effront/vite | effront, EffrontViteOptions | Vite and Cloudflare plugins |
@effront/cloudflare | effrontCloudflare, EffrontCloudflareOptions | Vite and Cloudflare plugins |
@effront/server/vite | effrontServer | Node.js / Bun server |
@effront/alchemy/cloudflare/vite | effrontAlchemy | Alchemy |
@effront/markdown | createMarkdownCollection, parseMarkdown, MarkdownError | Markdown |
@effront/tailwind | effrontTailwind | Tailwind |
@effront/markdown/document | MarkdownDocument, MarkdownDocumentProps | Markdown |
@effront/markdown/math | Math | Markdown |
@effront/markdown/mermaid | Mermaid | Markdown |
| @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.
| Member | Result | Reference |
|---|---|---|
Component, Page, Layout, Loading | Rendered content and route UI definitions | Components |
Routes, Middleware | Route groups and scoped request middleware | Routes and Middleware |
ServerFn | Schema-validated Server Functions | ServerFn |
withMiddleware | Derived factories with additional middleware and the same application identity | Application |
make | An application definition, not a running server | Application |
Dependency matrix
| Package or package family | Version |
|---|---|
| All Effront packages | 0.2.0 |
react, react-dom | 19.3.0 |
@vitejs/plugin-rsc | 0.5.35 |
effect, @effect/platform-browser, host-specific Effect packages | 4.0.0-rc.116 |
alchemy | 2.0.0-beta.79 |
@comark/react | 0.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.