{"id":25974340,"url":"https://github.com/falcondev-oss/trpc-vue-query","last_synced_at":"2025-06-12T16:09:15.761Z","repository":{"id":224247562,"uuid":"762762281","full_name":"falcondev-oss/trpc-vue-query","owner":"falcondev-oss","description":"Fully type-safe composables and helpers to make working with tRPC + Tanstack Query as intuitive as possible.","archived":false,"fork":false,"pushed_at":"2025-05-13T11:35:35.000Z","size":726,"stargazers_count":24,"open_issues_count":2,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-13T12:12:01.528Z","etag":null,"topics":["nuxt","tanstack-query","trpc","trpc-client","typescript","vue-query"],"latest_commit_sha":null,"homepage":"https://trpc-vue-query.falcondev.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/falcondev-oss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-02-24T16:13:13.000Z","updated_at":"2025-05-13T11:35:38.000Z","dependencies_parsed_at":"2024-02-24T19:56:39.494Z","dependency_job_id":"f514c9b9-9bf8-41c5-8689-d471d5fcbad4","html_url":"https://github.com/falcondev-oss/trpc-vue-query","commit_stats":null,"previous_names":["falcondev-it/trpc-vue-query","falcondev-oss/trpc-vue-query"],"tags_count":27,"template":false,"template_full_name":null,"purl":"pkg:github/falcondev-oss/trpc-vue-query","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/falcondev-oss%2Ftrpc-vue-query","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/falcondev-oss%2Ftrpc-vue-query/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/falcondev-oss%2Ftrpc-vue-query/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/falcondev-oss%2Ftrpc-vue-query/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/falcondev-oss","download_url":"https://codeload.github.com/falcondev-oss/trpc-vue-query/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/falcondev-oss%2Ftrpc-vue-query/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259500231,"owners_count":22867338,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nuxt","tanstack-query","trpc","trpc-client","typescript","vue-query"],"created_at":"2025-03-05T02:22:56.865Z","updated_at":"2025-06-12T16:09:15.751Z","avatar_url":"https://github.com/falcondev-oss.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tRPC Vue Query\n\n\u003ca href=\"https://npmjs.org/package/@falcondev-oss/trpc-vue-query\" title=\"View this project on NPM\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/@falcondev-oss/trpc-vue-query.svg\" alt=\"NPM version\" /\u003e\u003c/a\u003e\n\nA tRPC wrapper around @tanstack/vue-query. This package provides a set of hooks to use tRPC with Vue Query.\n\n## Installation\n\n```bash\npnpm add @falcondev-oss/trpc-vue-query\n```\n\n## Documentation\n\n👉 \u003chttps://trpc-vue-query.falcondev.io/getting-started\u003e 👈\n\n## Usage with Vue\n\n### 1. Create client \u0026 composable\n\n```ts\nimport { createTRPCVueQueryClient } from '@falcondev-oss/trpc-vue-query'\nimport { VueQueryPlugin, useQueryClient } from '@tanstack/vue-query'\n\nimport type { AppRouter } from '../your_server/trpc'\n\napp.use(VueQueryPlugin)\napp.use({\n  install(app) {\n    const queryClient = app.runWithContext(useQueryClient)\n    const trpc = createTRPCVueQueryClient\u003cAppRouter\u003e({\n      queryClient,\n      trpc: {\n        links: [\n          httpBatchLink({\n            url: '/api/trpc',\n          }),\n        ],\n      },\n    })\n\n    app.provide('trpc', trpc)\n  },\n})\n```\n\n```ts\nimport { createTRPCVueQueryClient } from '@falcondev-oss/trpc-vue-query'\n\nimport type { AppRouter } from '../your_server/trpc'\n\nexport function useTRPC() {\n  return inject('trpc') as ReturnType\u003ctypeof createTRPCVueQueryClient\u003cAppRouter\u003e\u003e\n}\n```\n\n### 2. Use it in your components\n\n```vue\n\u003cscript lang=\"ts\" setup\u003e\nconst { data: greeting } = useTRPC().hello.useQuery({ name: 'World' })\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cdiv\u003e\n    \u003ch1\u003e{{ greeting }}\u003c/h1\u003e\n  \u003c/div\u003e\n\u003c/template\u003e\n```\n\n### 3. Passing vue-query options\n\n```vue\n\u003cscript lang=\"ts\" setup\u003e\nconst { data: greeting } = useTRPC().hello.useQuery(\n  { name: 'World' },\n  {\n    refetchOnMount: false,\n    refetchOnReconnect: false,\n    refetchOnWindowFocus: false,\n    staleTime: 1000 * 60 * 5,\n  },\n)\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cdiv\u003e\n    \u003ch1\u003e{{ greeting }}\u003c/h1\u003e\n  \u003c/div\u003e\n\u003c/template\u003e\n```\n\n### 4. Using the `useMutation` hook\n\n```vue\n\u003cscript lang=\"ts\" setup\u003e\nconst name = ref('')\nconst { mutate: updateGreeting } = useTRPC().hello.update.useMutation({\n  onSuccess: () =\u003e {\n    console.log('Greeting updated')\n  },\n})\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cdiv\u003e\n    \u003cinput v-model=\"name\" type=\"text\" /\u003e\n    \u003cbutton @click=\"() =\u003e updateGreeting({ name })\"\u003eUpdate greeting\u003c/button\u003e\n  \u003c/div\u003e\n\u003c/template\u003e\n```\n\n## Usage with `trpc-nuxt`\n\nSetup `trpc-nuxt` as described in their [documentation](https://trpc-nuxt.vercel.app/get-started/usage/recommended). Then update the `plugins/client.ts` file:\n\n```ts\nimport { createTRPCVueQueryClient } from '@falcondev-oss/trpc-vue-query'\nimport { useQueryClient } from '@tanstack/vue-query'\nimport { httpBatchLink } from 'trpc-nuxt/client'\n\nimport type { AppRouter } from '~/server/trpc/routers'\n\nexport default defineNuxtPlugin(() =\u003e {\n  const queryClient = useQueryClient()\n\n  // ⬇️ use `createTRPCVueQueryClient` instead of `createTRPCNuxtClient` ⬇️\n  const trpc = createTRPCVueQueryClient\u003cAppRouter\u003e({\n    queryClient,\n    trpc: {\n      links: [\n        httpBatchLink({\n          url: '/api/trpc',\n        }),\n      ],\n    },\n  })\n\n  return {\n    provide: {\n      trpc,\n    },\n  }\n})\n```\n\n```ts\nexport function useTRPC() {\n  return useNuxtApp().$trpc\n}\n```\n\n## Acknowledgements\n\nHuge thanks to [Robert Soriano](https://github.com/wobsoriano) for creating `trpc-nuxt`! We just adapted his work to work with Vue Query.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffalcondev-oss%2Ftrpc-vue-query","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffalcondev-oss%2Ftrpc-vue-query","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffalcondev-oss%2Ftrpc-vue-query/lists"}