feat: allow passing DehydrateOptions as nuxt module option to dehydrate()

n0099 · n0099 · commit 99dcfc701251 · 2025-05-23T22:25:14.000Z
diff --git a/packages/vue-query-nuxt/src/runtime/plugin.ts b/packages/vue-query-nuxt/src/runtime/plugin.ts
@@ -5,7 +5,7 @@ import { pluginHook } from "#build/internal.vue-query-plugin-hook"
 import { defineNuxtPlugin, useRuntimeConfig, useState } from "#imports"
 
 export default defineNuxtPlugin((nuxt) => {
-  const { stateKey, queryClientOptions, vueQueryPluginOptions } = getVueQueryOptions(useRuntimeConfig())
+  const { stateKey, queryClientOptions, vueQueryPluginOptions, dehydrateOptions } = getVueQueryOptions(useRuntimeConfig())
   const vueQueryState = useState<DehydratedState | null>(stateKey)
   const queryClient = new QueryClient(queryClientOptions)
 
@@ -16,7 +16,7 @@ export default defineNuxtPlugin((nuxt) => {
 
   if (import.meta.server) {
     nuxt.hooks.hook("app:rendered", () => {
-      vueQueryState.value = dehydrate(queryClient)
+      vueQueryState.value = dehydrate(queryClient, dehydrateOptions)
     })
   }
 
diff --git a/packages/vue-query-nuxt/src/runtime/utils.ts b/packages/vue-query-nuxt/src/runtime/utils.ts
@@ -1,4 +1,4 @@
-import type { QueryClientConfig, VueQueryPluginOptions } from "@tanstack/vue-query"
+import type { QueryClientConfig, VueQueryPluginOptions, DehydrateOptions } from "@tanstack/vue-query"
 import type { RuntimeConfig } from "nuxt/schema"
 
 export const NAME = "vue-query-nuxt" as const
@@ -19,7 +19,8 @@ export interface ModuleOptions {
   stateKey: string
   autoImports: VueQueryComposables | false
   queryClientOptions: QueryClientConfig | undefined
-  vueQueryPluginOptions: VueQueryPluginOptions
+  vueQueryPluginOptions: VueQueryPluginOptions,
+  dehydrateOptions: DehydrateOptions
 }
 
 export const defaults: ModuleOptions = {
@@ -28,7 +29,8 @@ export const defaults: ModuleOptions = {
   queryClientOptions: {
     defaultOptions: { queries: { staleTime: 5000 } }
   },
-  vueQueryPluginOptions: {}
+  vueQueryPluginOptions: {},
+  dehydrateOptions: {}
 }
 export function getVueQueryOptions(config: RuntimeConfig) {
   return config.public[configKey] as ModuleOptions
