API reference

These documents describe the APIs implemented by the current source tree. They are the reference for application and tooling code. Developer internals separately contain architecture, proposals, and roadmap material that may describe APIs that do not exist yet.

Goldar is early-stage software. Every entry point is public because it is exported by the package, but not every entry point is intended for ordinary application code. The audience column makes that boundary explicit.

Entry points

Import	Audience	Reference
`goldar`	Applications; complete runtime surface	Runtime
`goldar/app`	Application assembly and request hooks	Runtime
`goldar/adapters/cloudflare`	Cloudflare Workers deployments	Cloudflare adapter
`goldar/adapters/node`	Node.js HTTP servers	Node adapter
`goldar/adapters/vercel`	Vercel Functions deployments	Vercel adapter
`goldar/async`	Shared `MaybePromise` type	Runtime
`goldar/client/custom-elements`	Browser-only Custom Element registration	Client
`goldar/data`	Request-scoped data resources	Runtime
`goldar/form-action`	Form actions and submissions	Runtime
`goldar/helpers`	Compatibility alias for `goldar/form-action`	Runtime
`goldar/router`	Routes, parameters, router, and route results	Runtime
`goldar/store`	Request-scoped store base types	Runtime
`goldar/view`	Compiled views, rendering, and trusted HTML	Runtime
`goldar/testing`	Black-box request and document tests	Testing
`goldar/cli`	Project command configuration	CLI
`goldar/compiler`	Low-level compiler process and artifact model	Compiler
`goldar/compiler/client`	Ambient `.hbs` and virtual-module declarations	Compiler
`goldar/compiler-runtime`	Generated-template runtime contract	Compiler
`goldar/vite`	Bundled Vite integration	Compiler
`goldar/typed-handlebars`	Programmatic editor tooling	Typed Handlebars
`goldar/language-server`	Embeddable language-server entry point	Typed Handlebars

Compiler-generated modules use goldar/compiler-runtime directly.

The template-language reference defines the implemented Handlebars subset, runtime semantics, unsupported syntax, and diagnostic codes shared by these compiler-facing entry points.

Usage guides

Getting started builds and runs a small rendered application.
Thinking in Goldar explains the framework’s ownership and request-lifetime model.
Typed Handlebars teaches the checked template language and composition model.
Template language is the authoring contract for compiled .hbs files.
Examples links nine runnable applications organized by behavior.
Package README summarizes installation and public subpaths.

Current limitations

The current server runtime does not implement client navigation, browser-side stores, streaming, route-level component chunks, or nested routers. Stores and data objects are request-scoped; persistence across requests belongs in cookies, a database, or another application service. See the capability map for the boundary between implemented behavior and design direction.