| description | See how routes, pages, middleware, and other optional directories map onto a Void app. |
|---|---|
| outline | deep |
A Void app uses file-based conventions to define routes, pages, middleware, and more. All directories are optional, so you only need the pieces your app actually uses.
File-based HTTP API endpoints built on Hono. Each file exports named HTTP method handlers.
- Named exports:
export const GET = defineHandler(...),export const POST = ... - Extensions:
.ts,.tsx,.js,.jsx,.mts, or.mjs; use.tsxor.jsxfor JSX handlers - Dynamic segments:
[id]becomes:idroute parameter - Catch-all:
[...slug]matches the remaining path - Route groups:
(admin)/organizes files without affecting URL paths - Files starting with
_are ignored - Environment suffix:
debug.dev.tsbuilds in development only,metrics.prod.tsin production only
See Server Routing for the full guide.
Full-stack server-rendered pages with co-located data loading. Available with Vue, React, Svelte, and Solid adapters.
.server.ts(or.tsx,.js,.jsx,.mts,.mjs) files exportloaderforGETdata andactionfor mutations, paired with the page component of the same name- Layouts nest automatically and persist across navigations
- Markdown pages are supported with frontmatter
- Environment suffix:
debug.dev.tsxis served in development only,stats.prod.tsxin production only
See Pages Routing for the full guide.
Global middleware that runs on every request. Numeric prefixes control execution order.
Each file default-exports a defineMiddleware() handler. Use middleware to set shared context (auth, logging, rate limiting) available to all routes.
Drizzle schemas and SQL migrations for D1, PostgreSQL, or MySQL.
db/schema.ts: your Drizzle table definitions and the source of truth for DB typesdb/schema/: optional. Split tables into separate files and re-export them fromdb/schema.tsdb/migrations/: generated SQL migration files, applied in order on deploy
Generate schema with void gen model or write it by hand. Generate migrations with void db generate.
Scheduled jobs. Each file exports a cron expression and a default defineScheduled() handler.
Queue consumers. Each file default-exports a defineQueue() handler.
Inbound email handlers. A file's name selects the recipient; _default.ts handles other addresses.
Durable State modules. Each file default-exports a defineDurableState() definition.
Shared application code such as components, utilities, and types. This directory has no special convention, so organize it however you like.
Static assets served as-is at the root path. Files here are not processed by Vite.
Generated types and local development state (gitignored). Run void prepare to create the types, or let vite dev and vite build update them.
| File | Purpose |
|---|---|
vite.config.ts |
Vite configuration. Must include voidPlugin(). |
void.config.ts |
Optional Void config for routing, inference, and worker settings |
tsconfig.json |
TypeScript config. Extend .void/tsconfig.json for auto-generated types; run void init --tsconfig when an existing config already uses extends. |
.env |
Local development values only (gitignored; never deployed) |
env.ts |
Checked-in env names, types, defaults, and requiredness |
See Environment Variables for local, production-secret, and client build behavior.