fix(hooks): additional error message when used outside of setup function

Author: DamianOsipiuk

src/__mocks__/vue-demi.ts

@@ -10,5 +10,5 @@ module.exports = {
   inject: jest.fn(),
   provide: jest.fn(),
   onUnmounted: jest.fn(),
-  getCurrentInstance: jest.fn(),
+  getCurrentInstance: jest.fn(() => ({ proxy: {} })),
 };

src/useQueryClient.ts

@@ -1,10 +1,18 @@
-import { inject } from "vue-demi";
+import { getCurrentInstance, inject } from "vue-demi";
 
 import type { QueryClient } from "react-query/types";
 
 export const VUE_QUERY_CLIENT = "VUE_QUERY_CLIENT";
 
 export function useQueryClient(): QueryClient {
+  const vm = getCurrentInstance()?.proxy;
+
+  if (!vm) {
+    throw new Error(
+      "vue-query hooks can only be used inside setup() function."
+    );
+  }
+
   const queryClient = inject<QueryClient>(VUE_QUERY_CLIENT);
 
   if (!queryClient) {

tests/useQueryClient.test.ts

@@ -1,8 +1,9 @@
-import { inject } from "vue-demi";
+import { getCurrentInstance, inject } from "vue-demi";
 import { useQueryClient, VUE_QUERY_CLIENT } from "../src/useQueryClient";
 
 describe("useQueryClient", () => {
   const injectSpy = inject as jest.Mock;
+  const getCurrentInstanceSpy = getCurrentInstance as jest.Mock;
 
   beforeEach(() => {
     jest.restoreAllMocks();
@@ -27,4 +28,11 @@ describe("useQueryClient", () => {
     expect(injectSpy).toHaveBeenCalledTimes(1);
     expect(injectSpy).toHaveBeenCalledWith(VUE_QUERY_CLIENT);
   });
+
+  test("should throw an error when used outside of setup function", () => {
+    getCurrentInstanceSpy.mockReturnValueOnce(undefined);
+
+    expect(useQueryClient).toThrowError();
+    expect(getCurrentInstanceSpy).toHaveBeenCalledTimes(1);
+  });
 });