Nuxt Query

Nuxt Query is a module for integrating Tanstack Query (formerly known as Vue Query) into your Nuxt application, providing a powerful solution for fetching, caching, synchronizing and updating server state.

• ✨  Release Notes

Features

• ⚙️   0 config integration
• 💪   Full support of Vue Query config settings
• 🏆   Support for complex QueryClient setup with handlers via hooks
• 🤖   Configurable auto-imports for Vue Query composables
• 🧩   Nuxt DevTools integration for easy debugging

Installation

You can add the module via the Nuxt CLI:

npx nuxi module add @peterbud/nuxt-query

or via npm:

pnpm dlx nuxi module add @peterbud/nuxt-query

Configuration

To configure Nuxt Query, update your nuxt.config.ts specifying the options you want for Vue Query:

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@peterbud/nuxt-query'],
  nuxtQuery: {
    // Specify which Vue Query composable(s) to auto-import
    autoImports: ['useQuery', 'useMutation'],

    // Enable / disable Nuxt DevTools integration (default: true).
    devtools: true,

    // These are the same options as the QueryClient 
    // from @tanstack/vue-query, will be passed 
    // to the QueryClient constructor
    // More details: https://tanstack.com/query/v5/docs/reference/QueryClient
    queryClientOptions: {
      defaultOptions: {
        queries: {
          // for example disable refetching on window focus
          refetchOnWindowFocus: false,

          // or change the default refetch interval
          refetchInterval: 5000,
        },
      },
    },
  },
})

Then, in your component, you can define and run queries with the useQuery composable (auto-imported):

// app.vue
<script setup>
const getPosts = async () => {
  await new Promise(resolve => setTimeout(resolve, 2000))
  return await $fetch('https://jsonplaceholder.typicode.com/posts')
}

const { isPending, isFetching, isError, data, error } = useQuery({
  queryKey: ['posts'],
  queryFn: getPosts,
})
</script>

That's it! You can now use Nuxt Query in your Nuxt app ✨

Module Hooks

Nuxt Query provides a hook that you can use in your application if you need a more complex setup for Vue Query, like custom query client with centralized onSuccess or onError handlers, which would not be possible to configure with the options available in the nuxt.config.ts.

The hook is called nuxt-query:configure and you can use it in a plugin to return a custom QueryClient object in the following way:

// plugins/nuxt-query.ts
import { QueryClient, QueryCache } from '@tanstack/vue-query'

export default defineNuxtPlugin({
  enforce: 'pre',
  setup(nuxtApp) {
    nuxtApp.hook('nuxt-query:configure', (getPluginOptions) => {
      const clientOptions = useRuntimeConfig().public.nuxtQuery?.queryClientOptions || {}

      const queryClient = new QueryClient({
        ...clientOptions,
        queryCache: new QueryCache({
          onSuccess: (data: unknown) => console.log('onSuccess', { data }),
        }),
      })

      // return the plugin options which will be used
      // by the module at startup
      getPluginOptions(queryClient)
    })
  },
})

Nuxt DevTools Integration

Nuxt Query integrates with Nuxt DevTools to provide a dedicated tab for Vue Query, where you can inspect the state of your queries, view their cache, and properties, initiate refetch or remove certain queries and more.

Contribution

Local development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev:client

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Build the module
npm run build

# Release new version
npm run release