Volt v0.1 · TypeScript APIs on Bun · Get started
Docs/Getting Started/Introduction to Volt

Introduction to Volt

Learn the request model, package structure, and where to start.

What is Volt?

Volt is a TypeScript API framework built around Bun's HTTP server and Web Standard Request and Response objects. You register routes, attach validation schemas, and return JSON, text, or a Response.

Start here

  1. Follow Quick Start to run your first endpoint.
  2. Build the Tasks API tutorial to learn CRUD and validation.
  3. Add tests, authentication, and OpenAPI.
  4. Use the package guide to find optional integrations.
  5. Explore Coming Soon for planned improvements.

What a request looks like

A registered route runs its captured middleware, parses the body for POST/PUT/PATCH, validates configured schemas, calls your handler, and serializes its result. An exception becomes an HTTP error response. Register middleware before its routes.

Current boundaries

Volt's native server uses Bun. A separate Node adapter is available. Route parameter names are inferred, but request body and query types are not automatically inferred from a route schema. Use Static<typeof Schema> explicitly when you need a TypeScript type. Database plugins need real clients for persistence; their defaults are mocks or memory stores. Read the limitations on each integration page.