feat(persist): Added hydrate and dehydrate options to the persistQueryClient function (TanStack#2131)

Author: gabrielbull

docs/src/pages/plugins/persistQueryClient.md

@@ -94,6 +94,10 @@ interface PersistQueryClientOptions {
   /** A unique string that can be used to forcefully
    * invalidate existing caches if they do not share the same buster string */
   buster?: string
+  /** The options passed to the hydrate function */
+  hydrateOptions?: HydrateOptions
+  /** The options passed to the dehydrate function */
+  dehydrateOptions?: DehydrateOptions
 }
 ```
 

src/persistQueryClient-experimental/index.ts

@@ -1,6 +1,6 @@
 import { QueryClient } from '../core'
 import { getLogger } from '../core/logger'
-import { dehydrate, DehydratedState, hydrate } from '../hydration'
+import { dehydrate, DehydratedState, DehydrateOptions, HydrateOptions, hydrate } from '../hydration'
 import { Promisable } from 'type-fest'
 
 export interface Persistor {
@@ -28,21 +28,27 @@ export interface PersistQueryClientOptions {
   /** A unique string that can be used to forcefully
    * invalidate existing caches if they do not share the same buster string */
   buster?: string
+  /** The options passed to the hydrate function */
+  hydrateOptions?: HydrateOptions
+  /** The options passed to the dehydrate function */
+  dehydrateOptions?: DehydrateOptions
 }
 
 export async function persistQueryClient({
   queryClient,
   persistor,
   maxAge = 1000 * 60 * 60 * 24,
   buster = '',
+  hydrateOptions,
+  dehydrateOptions,
 }: PersistQueryClientOptions) {
   if (typeof window !== 'undefined') {
     // Subscribe to changes
     const saveClient = () => {
       const persistClient: PersistedClient = {
         buster,
         timestamp: Date.now(),
-        clientState: dehydrate(queryClient),
+        clientState: dehydrate(queryClient, dehydrateOptions),
       }
 
       persistor.persistClient(persistClient)
@@ -59,7 +65,7 @@ export async function persistQueryClient({
           if (expired || busted) {
             persistor.removeClient()
           } else {
-            hydrate(queryClient, persistedClient.clientState)
+            hydrate(queryClient, persistedClient.clientState, hydrateOptions)
           }
         } else {
           persistor.removeClient()