Output Validation

tRPC gives you automatic type-safety of outputs without the need of adding a validator; however, it can be useful at times to strictly define the output type in order to prevent sensitive data of being leaked.

Similarily to input:, an output: validation to the query() and mutation() router methods. The output validator is invoked with the payload returned by the resolve() function.

When an output validator is defined, its inferred type is expected as the return type of the resolve() function.

info
  • This is entirely optional and only if you want to ensure you don’t accidentally leak anything e
  • If output validation fails, the server will respond with a INTERNAL_SERVER_ERROR.

Examples

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

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.   output: z.object({
  8.     greeting: z.string(),
  9.   }),
  10.   // expects return type of { greeting: string }
  11.   resolve() {
  12.     return {
  13.       greeting: 'hello!',
  14.     };
  15.   },
  16. });
  18. 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.   output: yup.object({
  8.     greeting: yup.string().required(),
  9.   }),
  10.   resolve() {
  11.     return { greeting: 'hello!' };
  12.   },
  13. });
  15. 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.string(),
  8.   output: t.object({
  9.     greeting: t.string(),
  10.   }),
  11.   resolve({ input }) {
  12.     return { greeting: input };
  13.   },
  14. });
  16. export type AppRouter = typeof appRouter;

With custom validator

  1. import * as trpc from '@trpc/server';
  2. import * as t from 'superstruct';
  4. // [...]
  6. export const appRouter = trpc.router<Context>().query('hello', {
  7.   output: (value: any) => {
  8.     if (value && typeof value.greeting === 'string') {
  9.       return { greeting: value.greeting };
  10.     }
  11.     throw new Error('Greeting not found');
  12.   },
  13.   // expects return type of { greeting: string }
  14.   resolve() {
  15.     return { greeting: 'hello!' };
  16.   },
  17. });
  19. export type AppRouter = typeof appRouter;