• Stars
    star
    152
  • Rank 244,685 (Top 5 %)
  • Language
    TypeScript
  • Created almost 2 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

An adapter, allowing you to use TRPC inside of Nest.JS

tRPC - Nest.JS Adapter

  • Allows you to use Trpc with Nest.JS.
  • Allows you to use request scoped Nest.JS providers
  • Allows you to use Nest.JS's great module system

Feature support

I don't use all of the features tRPC has :/

Both queries and mutations work.

I haven't tested subscriptions yet.

Batching doesn't work. Currently it't not possible to create multiple requests from 1 single HTTP request in Nest.JS (or it's a skill issue :) )

How

See the example folder in this repo, but briefly

yarn add trpc-nestjs-adapter

main.ts

// Standard  nest.js main.ts
import { NestFactory } from '@nestjs/core';
import { NestExpressApplication } from '@nestjs/platform-express';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create<NestExpressApplication>(AppModule);
  await app.listen(3000);
}

bootstrap();

app.module.ts

import { Module } from '@nestjs/common';
import { TrpcModule } from 'trpc-nestjs-adapter';
import { rootRouter } from './trpc/root-trpc.router.ts';
import { createContext }  from './trpc/create-context.ts';

@Module({
  imports: [
    AModule,
    TrpcModule.forRoot({
      path: '/trpc',
      router: rootRouter,
      createContext,
    }),
  ],
})
export class AppModule { }

Inside of your procedures

export const exampleMutation = trpc.procedure
    .input()
    .mutation(async ({ ctx })=>{
        const nestService = await ctx.resolveNestDependency(SomeNestService);

        await nestService.someServiceMethod()
    })

Note

The package is marked alpha for a reason, but mostly It's not documented very well.

If/When/As the package gains traction I'll improve the example & related docs.