\n The client above is not importing any code from the server, only its type declarations.\n
\n \n \n
\n\n## Introduction\n\n**NestJS tRPC** is a library designed to integrate the capabilities of tRPC into the NestJS framework. It aims to provide native support for decorators and implement an opinionated approach that aligns with NestJS conventions.\n\n## Features\n\n- ✅ Supports most tRPC features out of the box with more to come.\n- 🧙 Full static typesafety & autocompletion on the client, for inputs, outputs, and errors.\n- 🙀 Implements the Nestjs opinionated approach to how tRPC works.\n- ⚡️ Same client-side DX - We generate the AppRouter on the fly.\n- 🔋 Examples are available in the ./examples folder.\n- 📦 Out of the box support for **Dependency Injection** within the routes and procedures.\n- 👀 Native support for `express`, `fastify`, and `zod` with more drivers to come!\n\n## Quickstart\n\n### Installation\n\nTo install **NestJS tRPC** with your preferred package manager, you can use any of the following commands:\n\n```shell\n# bun\nbun add trpc-nestjs zod @trpc/server\n\n# npm\nnpm install trpc-nestjs zod @trpc/server\n\n# pnpm\npnpm add trpc-nestjs zod @trpc/server\n\n# yarn\nyarn add trpc-nestjs zod @trpc/server\n```\n\n## How to use\n\nHere's a brief example demonstrating how to use the decorators available in **NestJS tRPC**:\n\n```typescript\n// users.router.ts\nimport { Inject } from '@nestjs/common';\nimport { Router, Query, UseMiddlewares } from 'trpc-nestjs';\nimport { UserService } from './user.service';\nimport { ProtectedMiddleware } from './protected.middleware';\nimport { TRPCError } from '@trpc/server';\nimport { z } from 'zod';\n\nconst userSchema = z.object({\n name: z.string(),\n password: z.string()\n})\n\n@Router()\nclass UserRouter {\n constructor(\n @Inject(UserService) private readonly userService: UserService\n ) {}\n\n @UseMiddlewares(ProtectedMiddleware)\n @Query({ output: z.array(userSchema) })\n async getUsers() {\n try {\n return this.userService.getUsers();\n } catch (error: unknown) {\n throw new TRPCError({\n code: \"INTERNAL_SERVER_ERROR\",\n message: \"An error has occured when trying to get users.\",\n cause: error\n })\n }\n }\n}\n```\n\n**👉 See full documentation on [NestJS-tRPC.io](https://nestjs-trpc.io/docs). 👈**\n\n## All contributors\n\n> NestJS tRPC is developed by [Kevin Edry](https://twitter.com/KevinEdry), which taken a huge inspiration from both NestJS and tRPC inner workings.\n\n\n
![\"tRPC\"](\"https://i.imgur.com/JvsOXCg.png\")
![\"weekly](\"https://img.shields.io/npm/dm/nestjs-trpc.svg\")
\n \n \n ![\"MIT](\"https://img.shields.io/github/license/KevinEdry/nestjs-trpc\")
\n \n \n ![\"Discord\"](\"https://img.shields.io/discord/867764511159091230?color=7389D8&label&logo=discord&logoColor=ffffff\")
\n \n ![\"Demo\"](\"https://assets.trpc.io/www/v10/v10-dark-landscape.gif\")
\n