Documentation Index
Fetch the complete documentation index at: https://mintlify.com/middleapi/orpc/llms.txt
Use this file to discover all available pages before exploring further.
The Node.js adapter integrates with the node:http and node:https modules that ship with Node.js.
Installation
import { RPCHandler } from '@orpc/server/node'
Basic usage
import { createServer } from 'node:http'
import { RPCHandler } from '@orpc/server/node'
import { CORSPlugin } from '@orpc/server/plugins'
import { router } from './router'
const handler = new RPCHandler(router, {
plugins: [new CORSPlugin()],
})
const server = createServer(async (req, res) => {
const result = await handler.handle(req, res, {
context: { headers: req.headers },
})
if (!result.matched) {
res.statusCode = 404
res.end('No procedure matched')
}
})
server.listen(3000, '127.0.0.1', () =>
console.log('Listening on http://127.0.0.1:3000'),
)
handle(req, res, options)
| Parameter | Type | Description |
|---|
req | IncomingMessage | The incoming Node.js HTTP request |
res | ServerResponse | The outgoing Node.js HTTP response |
options.context | Initial context type | Context passed to middleware |
options.prefix | string (optional) | Strip this prefix before routing |
{ matched: true } if a procedure was matched, or { matched: false } otherwise.
Unlike the fetch adapter, the Node.js adapter writes the response to res directly rather than returning a Response object.
With Express
import express from 'express'
import { RPCHandler } from '@orpc/server/node'
import { router } from './router'
const app = express()
const handler = new RPCHandler(router)
app.use('/orpc', async (req, res, next) => {
const result = await handler.handle(req, res, {
prefix: '/orpc',
context: { headers: req.headers },
})
if (!result.matched) {
next()
}
})
app.listen(3000)
Options
Array of plugins to apply. See Plugins. strictGetMethodPluginEnabled
Restricts non-mutation procedures to GET requests.
Low-level interceptors around the full request handling cycle.
