Merge pull request #82 from DamianOsipiuk/useIsMutating/overloads

fix: useIsMutating overloads

Author: DamianOsipiuk

src/vue/__tests__/utils.test.ts

@@ -3,6 +3,7 @@ import {
   isQueryKey,
   parseFilterArgs,
   parseMutationArgs,
+  parseMutationFilterArgs,
   parseQueryArgs,
   updateState,
 } from "../utils";
@@ -106,6 +107,23 @@ describe("utils", () => {
     });
   });
 
+  describe("parseMutationFilterArgs", () => {
+    test("should default to empty filters", () => {
+      const result = parseMutationFilterArgs(undefined);
+
+      expect(result).toEqual(undefined);
+    });
+
+    test("should merge mutation key with filters", () => {
+      const filters = { fetching: true };
+
+      const result = parseMutationFilterArgs("key", filters);
+      const expected = { ...filters, mutationKey: "key" };
+
+      expect(result).toEqual(expected);
+    });
+  });
+
   describe("updateState", () => {
     test("should update first object with values from the second one", () => {
       const origin = { option1: "a", option2: "b", option3: "c" };

src/vue/index.ts

@@ -9,7 +9,12 @@ export { useInfiniteQuery } from "./useInfiniteQuery";
 export { useMutation } from "./useMutation";
 export { useIsFetching } from "./useIsFetching";
 export { useIsMutating } from "./useIsMutating";
-export { parseFilterArgs, parseMutationArgs, parseQueryArgs } from "./utils";
+export {
+  parseFilterArgs,
+  parseMutationArgs,
+  parseQueryArgs,
+  parseMutationFilterArgs,
+} from "./utils";
 
 export type { UseQueryOptions } from "./useQuery";
 export type { UseInfiniteQueryOptions } from "./useInfiniteQuery";

src/vue/useIsMutating.ts

@@ -1,12 +1,23 @@
 import { onUnmounted, Ref, ref } from "vue-demi";
+import type { QueryKey } from "react-query/types/core";
 import type { MutationFilters as MF } from "react-query/types/core/utils";
 
 import { useQueryClient } from "./useQueryClient";
+import { parseMutationFilterArgs } from "./utils";
 import type { WithQueryClientKey } from "./types";
 
 export type MutationFilters = WithQueryClientKey<MF>;
 
-export function useIsMutating(filters?: MutationFilters): Ref<number> {
+export function useIsMutating(filters?: MutationFilters): Ref<number>;
+export function useIsMutating(
+  queryKey?: QueryKey,
+  filters?: MutationFilters
+): Ref<number>;
+export function useIsMutating(
+  arg1?: QueryKey | MutationFilters,
+  arg2?: MutationFilters
+): Ref<number> {
+  const filters = parseMutationFilterArgs(arg1, arg2);
   const queryClient = useQueryClient(filters?.queryClientKey);
 
   const isMutating = ref(queryClient.isMutating(filters));

src/vue/utils.ts

@@ -7,7 +7,8 @@ import type {
   QueryKey,
   QueryOptions,
 } from "react-query/types/core";
-import type { QueryFilters } from "react-query/types/core/utils";
+import { QueryFilters } from "./useIsFetching";
+import { MutationFilters } from "./useIsMutating";
 
 export function isQueryKey(value: unknown): value is QueryKey {
   return typeof value === "string" || Array.isArray(value);
@@ -67,6 +68,18 @@ export function parseMutationArgs<
   return arg1;
 }
 
+export function parseMutationFilterArgs(
+  arg1?: QueryKey | MutationFilters,
+  arg2?: MutationFilters
+): MutationFilters | undefined {
+  if (isQueryKey(arg1)) {
+    return Object.assign(arg2, {
+      mutationKey: arg1,
+    });
+  }
+  return arg1;
+}
+
 export function updateState(
   state: Record<string, unknown>,
   update: Record<string, any>