Router

Introduction

A router is a collection of procedures with utilities that help reduce code duplication and improve organization.

import { os } from '@orpc/server'
 
const findUser = os.route({path: '/'}).func(() => {})
 
export const appRouter = os.router({
    user: {
        find: findUser,
    },
 
    nested: os
        .prefix('/users')  // Prefix will be concatenated with paths defined in route(...)
        .use((input, context, meta) => /* Logic applies for all routes in this router */ meta.next({}))
        .router({
            find: findUser,
        }),
})

All router functionality is fully typed and begins with the orpc instance, providing a consistent and intuitive API.

Key Features

Prefixing Routes

You can add a prefix to all routes in a router:

import { os } from '@orpc/server'
 
const userRouter = os
    .prefix('/users')
    .router({
        // ...
    })

Middleware Application

Apply middleware to all procedures in a router:

import { os } from '@orpc/server'
 
const authMiddleware = os.middleware(async (input, context, meta) => {
    // ...
    return meta.next({})
})
 
const protectedRouter = os
    .use(authMiddleware)
    .router({
       // ...
    })
// All routes in this router will require authentication

Nested Routers

Create hierarchical route structures:

import { os } from '@orpc/server'
 
const userRouter = os.router({
    // ...
})
 
const postRouter = os.router({
    // ...
})
 
const commentRouter = os.router({
    // ...
})
 
const apiRouter = os.router({
    users: userRouter,
    posts: postRouter,
    comments: os.prefix('/comments').router(commentRouter),
})

Infer Router Inputs and Outputs

The InferRouterInputs and InferRouterOutputs type utilities can be used to infer the input and output types of a router, respectively.

import { type InferRouterInputs, type InferRouterOutputs } from '@orpc/server'
import { router } from 'examples/server'
 
type Inputs = InferRouterInputs<typeof router>
type Outputs = InferRouterOutputs<typeof router>
 
type GettingInput = Inputs['getting']
type PostFindOutput = Outputs['post']['find']