@trpc/server

tRPC Server

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@trpc/server
20,9087710.10.04 days ago2 years agoMinified + gzip package size for @trpc/server in KB

Readme

tRPC


tRPC


End-to-end typesafe APIs made easy


Demo

@trpc/server
Create tRPC routers and connect them to a server.

Documentation

Full documentation for @trpc/server can be found here

Installation

# npm
npm install @trpc/server

# Yarn
yarn add @trpc/server

# pnpm
pnpm add @trpc/server

We also recommend installing zod to validate procedure inputs.

Basic Example

import { inferAsyncReturnType, initTRPC } from '@trpc/server';
import {
  CreateHTTPContextOptions,
  createHTTPServer,
} from '@trpc/server/adapters/standalone';
import { z } from 'zod';

// Initialize a context for the server
function createContext(opts: CreateHTTPContextOptions) {
  return {};
}

// Get the context type
type Context = inferAsyncReturnType<typeof createContext>;

// Initialize tRPC
const t = initTRPC.context<Context>().create();

// Create main router
const appRouter = t.router({
  // Greeting procedure
  greeting: t.procedure
    .input(
      z.object({
        name: z.string(),
      }),
    )
    .query(({ input }) => `Hello, ${input.name}!`),
});

// Export the app router type to be imported on the client side
export type AppRouter = typeof appRouter;

// Create HTTP server
const { listen } = createHTTPServer({
  router: appRouter,
  createContext,
});

// Listen on port 2022
listen(2022);