Ecosystem ↗

Capabilities and release status

Choose implemented features without confusing packages, adapters and future plans.

↗ View Markdown

These docs describe workspace source at 0.0.4, an early release. Availability is a code contract, not a statement that every deployment combination has been certified.

Framework capabilities#

Capability Current boundary
File routes and HTTP methods Implemented in the Node runtime
HTML and JSON responses Returned by application handlers
Middleware, controller references, plugins Discovered/registered during generation creation
Startup and thread workers Lifecycle-managed; cleanup remains application code
Compiled application build Server modules and manifest, not a static-site export
Multisite mapping Host/path-to-folder routing; authorization is separate
Fetch-compatible endpoints Explicit adapter with streamed request/response handling
React/Vue adapters Optional explicit native browser/server entries; store bridges remain separate
Project generators Zerux SSR; Zyro client/static/SSR/hydrated; Zenix host-configured SQLite scaffold
Zenix CMS Minimal SQLite core plus authenticated host-integrated setup/editor/published page; not a complete CMS

Independent packages#

Cache, search, feed, SEO, validation, file storage and many browser helpers can be used outside a Zerux application. Read package guides for runtime requirements: filesystem adapters are Node-only; focus/dialog helpers need a DOM; SMTP, Redis and object storage need external infrastructure.

Durability is feature-specific#

Memory caches, local search indexes, hook state and local snapshots are not distributed databases. BullMQ provides durable scheduling through Redis, but handlers are at-least-once. Analytics best-effort tracking remains the default; an explicit host-durable ingestion API has separate prerequisites. Numeric aggregates report indexed-only coverage. A shared versioned document store can coordinate control-plane writes only when the underlying store provides atomic compare-and-swap.

Future documentation versions#

Each docs version has its own Markdown content. Sources are linked on every page. When a feature changes, add or update the guide, reference contract, example and limitations together. Do not describe an intended capability as shipped simply because a package name exists.

TypeScript declarations are not feature activation#

The public configuration type has an open extension signature. A custom or compatibility field can therefore pass a root typecheck while no runtime code reads it. The configuration handbook distinguishes managed service setup, explicit package factories and declared-but-not-universal switches. Check a nested known option type when validating a service object.

A package export also describes an available function, not all of its operational prerequisites. Browser functions need a DOM, Redis processors need real Redis, and host callbacks such as authorization/persistence must be supplied by the application. A callback name in an example is not a bundled identity provider.

Evaluate a feature end to end#

Start from the installed package version and its public entry point. Follow the guide's setup, run one real operation, exercise invalid input/unavailable dependencies, then verify cleanup and production output. Report which environment was exercised. Source-level type checks, injected-driver tests, a static export and a real multi-instance deployment establish different evidence.

Use implemented exports and explicitly supported hosting modes. Generator output does not create production identity/storage policies. Roadmap entries never activate optional providers, and injected fixtures do not certify live infrastructure.

Implementation sources

Implementation files for the APIs described on this page.

ZeruxJS · Open source · MIT OR Apache-2.0

Make yourself at home.

Every shortcut has a visible control too. Reading and navigation work without JavaScript.

Ctrl / ⌘ K
Search all documentation
/
Search, outside editable fields
?
This help, outside editable fields
↑ / ↓
Move through search results
Esc
Close a dialog or version menu
Progress, privacy, offline reading and controls →

Reset this learning record?

This removes course answers, exercise confirmations, bookmarks and recent pages for this docs version in this browser. Export a copy first if you want to keep it.

Search documentation

Type at least two characters.