feat(hooks): add config param for queryProviders (#40)

* Add config param for useQueryProvider

* Add config param for useNuxtQueryProvider

Author: henribru

src/ssr/useNuxtQueryProvider.ts

@@ -1,9 +1,10 @@
 import { useContext } from "@nuxtjs/composition-api";
 import { useQueryClient, useQueryProvider } from "../index";
+import type { QueryClientConfig } from "../useQueryProvider";
 import { hydrate } from "./hydration";
 
-export function useNuxtQueryProvider(): void {
-  useQueryProvider();
+export function useNuxtQueryProvider(config: QueryClientConfig = {}): void {
+  useQueryProvider(config);
 
   // @ts-expect-error Nuxt.js injected client property
   if (process.client) {

src/useQueryProvider.ts

@@ -3,8 +3,13 @@ import { QueryClient } from "react-query/core";
 
 import { VUE_QUERY_CLIENT } from "./useQueryClient";
 
-export function useQueryProvider(): void {
-  const queryClient = new QueryClient();
+// QueryClientConfig isn't exported so we need to extract it
+export type QueryClientConfig = NonNullable<
+  ConstructorParameters<typeof QueryClient>[0]
+>;
+
+export function useQueryProvider(config: QueryClientConfig = {}): void {
+  const queryClient = new QueryClient(config);
   queryClient.mount();
 
   provide(VUE_QUERY_CLIENT, queryClient);

tests/ssr/useNuxtQueryProvider.test.ts

@@ -40,6 +40,21 @@ describe("useNuxtQueryProvider", () => {
     expect(useQueryProviderSpy).toHaveBeenCalledTimes(1);
   });
 
+  test("should call queryProvider with passed config", () => {
+    const config = {
+      defaultOptions: {
+        queries: {
+          enabled: false,
+        },
+      },
+    };
+    // @ts-expect-error Nuxt.js injected client property
+    process.client = false;
+    useNuxtQueryProvider(config);
+
+    expect(useQueryProviderSpy).toHaveBeenCalledWith(config);
+  });
+
   test("should call useQueryClient when vueQueryState is present", () => {
     useContextSpy.mockReturnValueOnce(withVueQueryState);
     useNuxtQueryProvider();

tests/useQueryProvider.test.ts

@@ -32,6 +32,20 @@ describe("useQueryProvider", () => {
     expect(queryClientSpy).toHaveBeenCalledTimes(1);
   });
 
+  test("should create queryClient with passed config", () => {
+    const config = {
+      defaultOptions: {
+        queries: {
+          enabled: false,
+        },
+      },
+    };
+
+    useQueryProvider(config);
+
+    expect(queryClientSpy).toBeCalledWith(config);
+  });
+
   test("should call mount on QueryClient", () => {
     useQueryProvider();