You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP →

@trpc/next

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@trpc/next

The tRPC Next.js library

10.45.2
latest
Source
npm

Version published: 5 months ago

Weekly downloads: 200K; increased by0.99%

Maintainers: 3

Created: 3 years ago

Weekly downloads

Package description

What is @trpc/next?

@trpc/next is a package that allows you to create end-to-end typesafe APIs using tRPC in a Next.js application. It simplifies the process of building and consuming APIs by leveraging TypeScript for type safety and Next.js for server-side rendering and API routes.

What are @trpc/next's main functionalities?

Creating a tRPC Router

This feature allows you to create a tRPC router with various procedures. In this example, a simple 'hello' query is defined that returns 'Hello world'.

import { initTRPC } from '@trpc/server';

const t = initTRPC.create();

const appRouter = t.router({
  hello: t.procedure.query(() => 'Hello world'),
});

export type AppRouter = typeof appRouter;

Integrating tRPC with Next.js API Routes

This feature demonstrates how to integrate a tRPC router with Next.js API routes. The `createNextApiHandler` function is used to create an API handler that can be used in a Next.js API route.

import { createNextApiHandler } from '@trpc/server/adapters/next';
import { appRouter } from 'path/to/your/router';

export default createNextApiHandler({
  router: appRouter,
  createContext: () => null,
});

Using tRPC in Next.js Pages

This feature shows how to use tRPC in a Next.js page. The `trpc.hello.useQuery` hook is used to fetch data from the 'hello' query defined in the tRPC router.

import { trpc } from 'path/to/trpc';

const HomePage = () => {
  const { data, error, isLoading } = trpc.hello.useQuery();

  if (isLoading) return <div>Loading...</div>;
  if (error) return <div>Error: {error.message}</div>;

  return <div>{data}</div>;
};

export default HomePage;

Other packages similar to @trpc/next

Readme

Source

tRPC

End-to-end typesafe APIs made easy

Demo

`@trpc/next`

Connect a tRPC router to Next.js.

Documentation

Full documentation for @trpc/next can be found here

Installation

# npm
npm install @trpc/next @trpc/react-query @tanstack/react-query@4

# Yarn
yarn add @trpc/next @trpc/react-query @tanstack/react-query@4

# pnpm
pnpm add @trpc/next @trpc/react-query @tanstack/react-query@4

# Bun
bun add @trpc/next @trpc/react-query @tanstack/react-query@4

Basic Example

Setup tRPC in utils/trpc.ts.

import { createTRPCNext, httpBatchLink } from '@trpc/next';
// Import the router type from your server file
import type { AppRouter } from '../pages/api/[trpc].ts';

export const trpc = createTRPCNext<AppRouter>({
  config() {
    return {
      links: [
        httpBatchLink({
          url: 'http://localhost:3000/trpc',
        }),
      ],
    };
  },
  ssr: true,
});

Hook up tRPC inside _app.tsx.

import { trpc } from '~/utils/trpc';

const App = ({ Component, pageProps }) => {
  return <Component {...pageProps} />;
};

export default trpc.withTRPC(App);

Now you can query your API in any component.

import { trpc } from '~/utils/trpc';

export function Hello() {
  const { data, error, status } = trpc.greeting.useQuery({
    name: 'tRPC',
  });

  if (error) {
    return <p>{error.message}</p>;
  }

  if (status !== 'success') {
    return <p>Loading...</p>;
  }

  return <div>{data && <p>{data.greeting}</p>}</div>;
}

FAQs

What is @trpc/next?

Is @trpc/next popular?

Is @trpc/next well maintained?

Package last updated on 11 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install