Askr Documentation
Build browser, server, static, and full-stack TypeScript applications with the current published Askr packages.
@askrjs/askr0.0.59
How to use askr documentation
Begin at the owning package boundary, keep the application contract explicit, and verify the generated or server result before adding abstraction.
- Import the published @askrjs/askr entrypoint.
- Keep askr documentation configuration next to the component, route, or server composition root that owns it.
- Handle pending, unavailable, cancellation, and failure states, then verify the production path.
import { state } from '@askrjs/askr';
const ready = state(false);
ready.set(true);Choose a path
If you're starting a new project, head to Getting Started and follow the installation and quick-start pages in order — they walk through installing @askrjs/askr and wiring up createSPA or createIsland. If you already have an app running and want to look something up, use the search bar or jump straight to the section that matches what you're doing: Fundamentals for state and reactivity, Routing for the router package, Data for resource() and query helpers, or Components for the UI library. The API Reference section is generated directly from each package's shipped .d.ts files, so it's the fastest place to check an exact export or type signature.
Published package set
Askr ships as a set of independently versioned packages under the @askrjs scope rather than one monolith — @askrjs/askr is the core runtime (state, derive, boot, router, resources, SSR/SSG), and adjacent packages like @askrjs/ui, @askrjs/auth, @askrjs/charts, @askrjs/server, @askrjs/schema, @askrjs/fetch, @askrjs/i18n, and @askrjs/cli cover UI components, authentication, charting, server integration, validation, HTTP, localization, and tooling respectively. Each package has its own version number and release cadence, which is why the docs track them separately instead of a single framework version. The full list with current published versions is at the bottom of this page.
Application modes
@askrjs/askr supports more than one way to run an app: createSPA from @askrjs/askr/boot boots a client-rendered single-page app using routes registered through @askrjs/askr/router, while createIsland mounts a single component into an existing page for partial hydration. The same runtime also exposes ssr and ssg subpaths, so the same components can render on the server for request-time HTML or be pre-rendered into static output ahead of time. Which mode you pick changes where routing and data-fetching code runs, but the core primitives — state(), derive(), resource() — behave the same regardless of the mode you choose.
Published versions
| Package | Version |
|---|---|
@askrjs/askr | 0.0.59 |
@askrjs/auth | 0.0.3 |
@askrjs/charts | 0.1.2 |
@askrjs/cli | 0.0.5 |
@askrjs/fetch | 0.0.1 |
@askrjs/i18n | 0.0.2 |
@askrjs/logos | 0.0.4 |
@askrjs/lucide | 0.0.4 |
@askrjs/monaco | 0.0.2 |
@askrjs/node | 0.0.3 |
@askrjs/otel | 0.0.2 |
@askrjs/schema | 0.0.2 |
@askrjs/server | 0.0.3 |
@askrjs/themes | 0.0.13 |
@askrjs/ui | 0.0.13 |
@askrjs/vite | 0.0.7 |