API Reference
Browse generated API reference for each published rest-rpc package.
Each package’s API reference is automatically generated from its TypeScript source code and include all exported types, functions, and classes, along with their documentation comments. The references are available on npmx.dev.
Only package entry points are considered public API. Subpath exports, undocumented declarations, and declarations that are not exported from a package root are internal details and may change without notice.
| Package | Purpose | Related Docs |
|---|---|---|
@rest-rpc/core |
Contract declaration, fetch client, OpenAPI generation, and shared type helpers. | Contract, Fetch Client, OpenAPI, Type Helpers |
@rest-rpc/server |
Shared server primitives used by the built-in adapters and adapter authors. | Server Adapter Design, Building Server Adapters, Type Helpers |
@rest-rpc/express |
Express route registration and implementation helpers. | Express, WebSockets |
@rest-rpc/fastify |
Fastify route registration and implementation helpers. | Fastify, WebSockets |
@rest-rpc/hono |
Hono route registration and implementation helpers. | Hono, WebSockets |
@rest-rpc/web |
Web Request to Response adapter for fetch-native runtimes. |
Web, Building Server Adapters |
@rest-rpc/next |
Next.js route handler helpers built on the Web adapter. | Next.js, Web |
@rest-rpc/tanstack-query |
TanStack Query option and key helpers generated from a contract. | TanStack Query, Type Helpers |