Define Router

info
  • A procedure can be viewed as the equivalent of a REST-endpoint.
  • There’s no internal difference between queries and mutations apart from semantics.
  • Defining router is the same for queries, mutations, and subscription with the exception that subscriptions need to return a Subscription-instance.

Input validation

tRPC works out-of-the-box with yup/superstruct/zod/myzod/custom validators/[..] - see test suite

Example without input

  1. import * as trpc from '@trpc/server';
  3. // [...]
  5. export const appRouter = trpc
  6.   .router<Context>()
  7.   // Create procedure at path 'hello'
  8.   .query('hello', {
  9.     resolve({ ctx }) {
  10.       return {
  11.         greeting: `hello world`,
  12.       };
  13.     },
  14.   });

With Zod

  1. import * as trpc from '@trpc/server';
  2. import { z } from 'zod';
  4. // [...]
  6. export const appRouter = trpc.router<Context>().query('hello', {
  7.   input: z
  8.     .object({
  9.       text: z.string().nullish(),
  10.     })
  11.     .nullish(),
  12.   resolve({ input }) {
  13.     return {
  14.       greeting: `hello ${input?.text ?? 'world'}`,
  15.     };
  16.   },
  17. });
  19. export type AppRouter = typeof appRouter;

With Yup

  1. import * as trpc from '@trpc/server';
  2. import * as yup from 'yup';
  4. // [...]
  6. export const appRouter = trpc.router<Context>().query('hello', {
  7.   input: yup.object({
  8.     text: yup.string().required(),
  9.   }),
  10.   resolve({ input }) {
  11.     return {
  12.       greeting: `hello ${input?.text ?? 'world'}`,
  13.     };
  14.   },
  15. });
  17. export type AppRouter = typeof appRouter;

With Superstruct

  1. import * as trpc from '@trpc/server';
  2. import * as t from 'superstruct';
  4. // [...]
  6. export const appRouter = trpc.router<Context>().query('hello', {
  7.   input: t.object({
  8.     /**
  9.      * Also supports inline doc strings when referencing the type.
  10.      */
  11.     text: t.defaulted(t.string(), 'world'),
  12.   }),
  13.   resolve({ input }) {
  14.     return {
  15.       greeting: `hello ${input.text}`,
  16.     };
  17.   },
  18. });
  20. export type AppRouter = typeof appRouter;

Method chaining

To add multiple endpoints, you must chain the calls

  1. import * as trpc from '@trpc/server';
  3. // [...]
  5. export const appRouter = trpc
  6.   .router<Context>()
  7.   .query('hello', {
  8.     resolve() {
  9.       return {
  10.         text: `hello world`,
  11.       };
  12.     },
  13.   })
  14.   .query('bye', {
  15.     resolve() {
  16.       return {
  17.         text: `goodbye`,
  18.       };
  19.     },
  20.   });
  22. export type AppRouter = typeof appRouter;