RPC Handler

RPCHandler enables communication with clients over oRPC's proprietary RPC protocol.

Designed exclusively for RPCLink. Avoid sending requests manually.

Supported Data Types

• string, number (including NaN)
• boolean, null, undefined
• Date (including Invalid Date)
• BigInt, RegExp, URL
• Record (object), Array
• Set, Map
• Blob (unsupported in AsyncIteratorObject)
• File (unsupported in AsyncIteratorObject)
• AsyncIteratorObject (only at root level; powers Event Iterator)

Setup

import { RPCHandler } from '@orpc/server/fetch'
import { CORSPlugin } from '@orpc/server/plugins'
import { onError } from '@orpc/server'

const handler = new RPCHandler(router, {
  plugins: [new CORSPlugin()],
  interceptors: [onError(e => console.error(e))],
})

export default async function fetch(request: Request) {
  const { matched, response } = await handler.handle(request, {
    prefix: '/rpc',
    context: {}
  })

  if (matched) return response
  return new Response('Not Found', { status: 404 })
}

Filtering Procedures

const handler = new RPCHandler(router, {
  filter: ({ contract, path }) => !contract['~orpc'].route.tags?.includes('internal'),
})

Default Plugins

Plugin	Applies To	Toggle Option
StrictGetMethodPlugin	HTTP Adapter	strictGetMethodPluginEnabled

Lifecycle

sequenceDiagram
  actor A1 as Client
  participant P3 as Request/Response encoder
  participant P4 as Router + Input/Output encoder
  participant P5 as Server-Side Procedure Client

  A1 ->> P3: request
  P3 ->> P4: standard request
  P4 ->> P4: Find procedure
  P4 ->> P4: Load body + decode request
  P4 ->> P5: Input, Signal, LastEventId,...
  P5 ->> P5: Handle
  P5 ->> P4: success/failure
  P4 ->> P3: standard response
  P3 ->> A1: response

Interceptors can intercept and modify the lifecycle at various stages.