Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: export arg parse utils #68

Merged
merged 1 commit into from
Aug 20, 2021
Merged

fix: export arg parse utils #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 4 additions & 33 deletions src/vue/__tests__/utils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,48 +19,19 @@ describe("utils", () => {
});

describe("parseFilterArgs", () => {
test("should default to empty options", () => {
const filters = { active: true };

const result = parseFilterArgs(filters);
const expected = [filters, {}];

expect(result).toEqual(expected);
expect(result[0]).toBe(filters);
});

test("should default to empty filters", () => {
const options = { option1: false };

const result = parseFilterArgs(undefined, options);
const expected = [{}, options];
const result = parseFilterArgs(undefined);

expect(result).toEqual(expected);
expect(result[1]).toBe(options);
});

test("should covert to array of parameters", () => {
const filters = { active: true };
const options = { option1: false };

const result = parseFilterArgs(filters, options);
const expected = [filters, options];

expect(result).toEqual(expected);
expect(result[0]).toBe(filters);
expect(result[1]).toBe(options);
expect(result).toEqual({});
});

test("should merge query key with filters", () => {
const filters = { active: true };
const options = { option1: false };

const result = parseFilterArgs("key", filters, options);
const expected = [{ ...filters, queryKey: "key" }, options];
const result = parseFilterArgs("key", filters);
const expected = { ...filters, queryKey: "key" };

expect(result).toEqual(expected);
expect(result[0]).toBe(filters);
expect(result[1]).toBe(options);
});
});

Expand Down
1 change: 1 addition & 0 deletions src/vue/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ export { useInfiniteQuery } from "./useInfiniteQuery";
export { useMutation } from "./useMutation";
export { useIsFetching } from "./useIsFetching";
export { useIsMutating } from "./useIsMutating";
export { parseFilterArgs, parseMutationArgs, parseQueryArgs } from "./utils";

export type { UseQueryOptions } from "./useQuery";
export type { UseInfiniteQueryOptions } from "./useInfiniteQuery";
Expand Down
4 changes: 2 additions & 2 deletions src/vue/useIsFetching.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export function useIsFetching(
arg2?: QueryFilters
): Ref<number> {
const filters: Ref<QueryFilters> = ref({});
const [parsedFilters] = parseFilterArgs(arg1, arg2);
const parsedFilters = parseFilterArgs(arg1, arg2);
filters.value = parsedFilters;

const queryClient = useQueryClient(parsedFilters.queryClientKey);
Expand All @@ -30,7 +30,7 @@ export function useIsFetching(
});

watchEffect(() => {
const [parsedFilters] = parseFilterArgs(arg1, arg2);
const parsedFilters = parseFilterArgs(arg1, arg2);
filters.value = parsedFilters;
});

Expand Down
17 changes: 5 additions & 12 deletions src/vue/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,15 @@ export function parseQueryArgs<TOptions extends QueryOptions<any, any, any>>(
return Object.assign(arg2, { queryKey: arg1 }) as TOptions;
}

export function parseFilterArgs<
TFilters extends QueryFilters,
TOptions = unknown
>(
export function parseFilterArgs<TFilters extends QueryFilters>(
arg1?: QueryKey | TFilters,
arg2: TFilters | TOptions = {} as TOptions,
arg3: TOptions = {} as TOptions
): [TFilters, TOptions | undefined] {
arg2?: TFilters
): TFilters {
if (isQueryKey(arg1)) {
return [Object.assign(arg2, { queryKey: arg1 }), arg3] as [
TFilters,
TOptions
];
return Object.assign(arg2, { queryKey: arg1 });
}

return [arg1 || {}, arg2] as [TFilters, TOptions];
return arg1 || ({} as TFilters);
}

export function parseMutationArgs<
Expand Down