Giter VIP home page Giter VIP logo

trpc-nitro-adapter's Introduction

tRPC.io Nitro Adapter

A tRPC adapter for the nitro web server framework.

Requirements

  • tRPC v10..
  • nitro v.2.4.* or higher
  • h3 v.1.6.* or higher

Installation

npm install trpc-nitro-adapter
pnpm add trpc-nitro-adapter
yarn add trpc-nitro-adapter

Usage

First of all you need a router to handle your queries, mutations and subscriptions.

A sample router is given below, saved in in a file named .trpc/router.ts*. Note, if your router file starts getting too big, split your router into several subrouters each implemented in its own file. Then merge them into a single root appRouter.

To read more about how to define a router, please consult the tRPC router documentation.

// file: ./trpc/router.ts

import { initTRPC } from '@trpc/server'

export const t = initTRPC.create()

export const appRouter = t.router({
  // ... define your routes here
})

// Export your type definition for use in the adapter:
export type AppRouter = typeof appRouter

Please consult the tRPC documentation for more information on how to create a router.

Then, in your nitro server, create a file in your routes directory named [...trpc].ts to ensure that the trpc param is passed to your nitro eventHandler.

// file: /routes/[...trpc].ts

// Import your router:
import { appRouter } from './trpc/router.ts'

import { defineNitroTRPCEventHandler } from 'trpc-nitro-adapter'

// Export as default the defineNitroTRPCEventHandler function:
export default defineNitroTRPCEventHandler({
  router: appRouter,
  createContext: () => {
    // Return your custom defined context here:
    return {}
  }
})

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.