Reference
How to read the curated API reference — core symbols, adapter hooks, roadmap, and migration.
The symbols and hook signatures you reach for most often — with minimal examples and cross-links to concept pages for behavior. Curated and human-readable, not exhaustive; the generated API reference is the contract of record.
What’s here
| Page | Contents |
|---|---|
| Core API | LayerClient, LayerStack, layerOptions, typing helpers, errors, and utilities — a curated tour; see the generated reference for every export |
| Adapter hooks | Hook and provider matrix across React, Preact, Solid, Angular, Vue, Lit, Alpine, and Svelte |
| Roadmap | Forward-looking work — not a mirror of shipped src/ |
| Migration | Breaking-change policy and migration notes when they ship |
| API reference | Exhaustive CI-generated TypeDoc reference — every export across core and the adapters, regenerated on every docs build |
Release history
Breaking changes and semver releases are announced in the Changelog. Pin your version in production; see Stability & versioning for the pre-1.0 posture.