mirror of
https://github.com/ArthurDanjou/trpc-nuxt.git
synced 2026-01-14 12:14:40 +01:00
81d8497f2025e287b8ca38da2d28a312cd488e9b
tRPC-Nuxt
End-to-end typesafe APIs with tRPC.io in Nuxt applications.
Install
npm i trpc-nuxt -D
// nuxt.config.ts
import { defineNuxtConfig } from 'nuxt'
export default defineNuxtConfig({
modules: ['trpc-nuxt'],
})
Usage
Create your tRPC routes and context under server/fn/index.ts:
// ~/server/fn/index.ts
import type { inferAsyncReturnType } from '@trpc/server'
import * as trpc from '@trpc/server'
export const router = trpc
.router<inferAsyncReturnType<typeof createContext>>()
// queries and mutations...
.query('hello', {
resolve: () => 'world',
})
// optional
export const createContext = () => {
// ...
return {
/** context data */
}
}
// optional
export const responseMeta = () => {
// ...
return {
// { headers: ... }
}
}
Use the client like so:
<script setup lang="ts">
const client = useClient()
const data = await client.query('hello')
console.log(data) // => 👈 world
</script>
Composables
Composables are auto-imported.
###useTrpcQuery(path, input)
Languages
TypeScript
88.1%
Vue
11.9%