Skip to content
You are reading the v2 docs, currently in beta.V1 docs
oRPC
Esc
↑↓navigate↵open⌘Jpreview
On this page

Plugins

Add CORS, batching, retries, compression, timeouts, and validation to oRPC with built-in plugins for handlers on the server and links on the client.

Plugins add reusable behavior through the plugins option. Handler plugins (...HandlerPlugin) run on the server, in a handler such as the RPC Handler. Link plugins (...LinkPlugin) run on the client, in a link such as the RPC Link. Some features need both.

Security

Performance

Reliability

  • Retry (client): retry failed calls.
  • Retry After (client): retry when the server sends Retry-After.
  • Timeout (both): abort calls that take too long.
  • Signal Sync (server): keep the request signal and streaming responses in sync.

Headers and HTTP

  • Request Headers (server): read headers through context.reqHeaders.
  • Response Headers (server): set headers and cookies through context.resHeaders.
  • Method Override (server): let HTML forms call PUT, PATCH, and DELETE.
  • Rethrow (server): pass errors on to your framework’s error handling.

Validation and Types

Files and Docs

  • Static File (server): serve static files next to your procedures.
  • Tmp File Upload (server): stream large uploads to temporary files.
  • OpenAPI Reference (server): serve Scalar or Swagger UI and the OpenAPI document.

Last updated on

Was this page helpful?