mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* docs(query-core): add JSDoc across the package and expose it in generated reference docs * docs(config.json): add sidebar entries for newly generated query-core reference docs * docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc * docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference * docs(query-core): regenerate reference docs after merging main * docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type * fix(query-devtools): drop unnecessary 'query-core' project reference * docs(query-core): document missing default values and normalize 'Defaults to' spacing * docs(query-core): fix 'environmentManager' JSDoc example
1.4 KiB
1.4 KiB
| id | title |
|---|---|
| VueQueryPlugin | VueQueryPlugin |
const VueQueryPlugin: object;
Defined in: packages/vue-query/src/vueQueryPlugin.ts:74
Installs a QueryClient on the Vue app, making it available to every descendant component through
useQueryClient — the Vue equivalent of React's QueryClientProvider, but wired up as an app-level plugin
instead of a wrapping component.
Type Declaration
install()
install: (app, options) => void;
Parameters
app
any
options
Returns
void
Examples
import { createApp } from 'vue'
import { VueQueryPlugin } from '@tanstack/vue-query'
const app = createApp(App)
app.use(VueQueryPlugin)
Pass a queryClient you constructed yourself — useful for SSR, where you need a fresh QueryClient per
request, or when the same instance also needs to be used outside of Vue components:
import { QueryClient, VueQueryPlugin } from '@tanstack/vue-query'
const queryClient = new QueryClient()
app.use(VueQueryPlugin, { queryClient })
Or pass queryClientConfig to let the plugin construct the QueryClient for you, with your own defaults:
app.use(VueQueryPlugin, {
queryClientConfig: {
defaultOptions: { queries: { staleTime: 5 * 1000 } },
},
})