Reference Index
Status terms:
- Current: exported and covered by repository tests.
- Experimental: implemented, but its compatibility contract may still move.
- Planned: tracked work; do not depend on it as an existing feature.
| Concept | Primary API | Status |
|---|---|---|
| Application |
createApp, app.useLayers, app.mount
|
Current |
| Component |
define, defineProps, script, template
|
Current |
| Reactivity |
signal, computed, watch, watchEffect
|
Current |
| Rendering | JSX runtime, For, Show, Switch, Await
|
Current |
| Async UI |
Suspense, ErrorBoundary
|
Current |
| Context |
createTypedContext, provide/inject
|
Current |
| Context (legacy) |
createContext, useContext
|
Deprecated: not SSR-correct |
| Refs | object and callback refs | Current |
| Events |
useEmits, event modifiers |
Current |
| Hooks |
defineHook, lifecycle-scoped effects |
Current |
| Layers |
defineLayer, services, dependencies, lifecycle |
Current |
| Layer bindings | alias records and direct helpers | Current |
| Layer tracing | tracing service and hook/layer spans | Experimental |
| Concept | Primary API | Status |
|---|---|---|
| Router |
createRouter, histories, installRouter
|
Current |
| Route declarations |
defineRoutes, nested records, aliases |
Current |
| Dynamic segments |
:id, [id], [...slug], [[...slug]]
|
Current |
| Route groups |
(group) path segments omitted from URLs |
Current |
| Navigation |
Link, RouterView, useRoute, useRouter
|
Current |
| Guards | global and route guards | Current |
| SSR runtime |
createSSRRuntime, renderToString
|
Current |
| Server app |
createServerApp, createHandler
|
Current |
| Streaming |
createStreamingHandler, deferred-head shell flush |
Current |
| Layer API routes | defineLayer({ server: { api } }) |
Current |
| Layer actions | defineLayer({ server: { actions } }) |
Current |
| Server validation |
serverSchema, validator helpers, typed error bodies |
Current |
| File server routes | fromServerFiles |
Experimental |
| Server middleware |
defineServerMiddleware, compileServerMiddlewareGraph, runServerRequestPipeline
|
Current |
| Response cache |
createResponseCache, tag invalidation |
Current |
| Data cache |
cached, createDataCache
|
Current |
| Scheduled tasks | createTaskScheduler |
Current |
| Storage |
EffuseStorage, createMemoryStorage, runStorageConformance
|
Current |
| Plugins | createPluginHost |
Current |
| Server manifest | createLayerServerManifest |
Current |
| Manifest client | createLayerServerManifestClient |
Current |
| Generated client module | generateLayerServerClientModule |
Experimental |
| Unified route graph | client, server, metadata, and layouts | Planned: #218 |
| Package | Purpose | Status |
|---|---|---|
@effuse/core |
Runtime, rendering, layers, SSR, server APIs | Experimental |
@effuse/router |
SPA routing and navigation | Experimental |
@effuse/store |
Effect-based reactive stores | Experimental |
@effuse/query |
Server-state cache and mutations | Experimental |
@effuse/use |
Browser and lifecycle hooks | Experimental |
@effuse/i18n |
Typed translations, locale state, request-scoped SSR instances | Experimental |
@effuse/ink |
Reactive Markdown, embedded components, SSR-safe styles and URL sanitization | Experimental |
@effuse/compiler |
JSX/TSX transformation | Experimental |
@effuse/cli |
Dev server, build, and generated entries | Experimental |