mirror of
https://github.com/ArthurDanjou/trpc-nuxt.git
synced 2026-01-14 12:14:40 +01:00
95 lines
2.0 KiB
Markdown
95 lines
2.0 KiB
Markdown
# tRPC-Nuxt
|
|
|
|
[](https://www.npmjs.com/package/trpc-nuxt)
|
|
|
|
End-to-end typesafe APIs with [tRPC.io](https://trpc.io/) in Nuxt applications.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
npm i trpc-nuxt
|
|
```
|
|
|
|
```ts
|
|
// nuxt.config.ts
|
|
import { defineNuxtConfig } from 'nuxt'
|
|
|
|
export default defineNuxtConfig({
|
|
modules: ['trpc-nuxt'],
|
|
trpc: {
|
|
baseURL: 'http://localhost:3000', // defaults to http://localhost:3000
|
|
trpcURL: '/api/trpc', // defaults to /api/trpc
|
|
},
|
|
typescript: {
|
|
strict: true // set this to true to make input/output types work
|
|
}
|
|
})
|
|
```
|
|
|
|
## Usage
|
|
|
|
Expose your tRPC [routes](https://trpc.io/docs/router) under `~/server/trpc/index.ts`:
|
|
|
|
```ts
|
|
// ~/server/trpc/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',
|
|
})
|
|
.query('bye', {
|
|
resolve() {
|
|
return {
|
|
text: 'goodbye',
|
|
}
|
|
},
|
|
})
|
|
```
|
|
|
|
Use the client like so:
|
|
|
|
```html
|
|
<script setup lang="ts">
|
|
const client = useClient()
|
|
|
|
const greeting = await client.query('hello');
|
|
console.log(greeting); // => 👈 world
|
|
|
|
const farewell = await client.query('bye');
|
|
console.log(farewell); // => 👈 goodbye
|
|
</script>
|
|
```
|
|
|
|
## `useTRPCAsyncData`
|
|
|
|
A composable that wraps Nuxt's [`useAsyncData`](https://v3.nuxtjs.org/api/composables/use-async-data/) with some modifications to have better error handlings.
|
|
|
|
```ts
|
|
const path = 'hello'
|
|
const client = useClient()
|
|
|
|
const {
|
|
data,
|
|
pending,
|
|
error,
|
|
refresh
|
|
} = await useTRPCAsyncData(path, () => client.query(path))
|
|
console.log(data.value) // => 👈 world
|
|
```
|
|
|
|
## Recipes
|
|
|
|
- [Validation](/recipes/validation.md)
|
|
- [Authorization](/recipes/authorization.md)
|
|
- [Error Handling](/recipes/error-handling.md)
|
|
|
|
Learn more about tRPC.io [here](https://trpc.io/docs).
|
|
|
|
## License
|
|
|
|
MIT
|