Commit af2d6680 authored by tom's avatar tom

Cancel previous search queries when typing

Fixes #2149
parent d6e06153
import type { QueryKey, UseQueryOptions } from '@tanstack/react-query'; import type { QueryKey, UseQueryOptions } from '@tanstack/react-query';
import { useQuery } from '@tanstack/react-query'; import { useQuery } from '@tanstack/react-query';
import type { ResourceError, ResourceName, ResourcePayload } from './resources'; import type { Params as FetchParams } from 'lib/hooks/useFetch';
import type { Params as ApiFetchParams } from './useApiFetch';
import type { ResourceError, ResourceName, ResourcePathParams, ResourcePayload } from './resources';
import useApiFetch from './useApiFetch'; import useApiFetch from './useApiFetch';
export interface Params<R extends ResourceName, E = unknown, D = ResourcePayload<R>> extends ApiFetchParams<R> { export interface Params<R extends ResourceName, E = unknown, D = ResourcePayload<R>> {
pathParams?: ResourcePathParams<R>;
queryParams?: Record<string, string | Array<string> | number | boolean | undefined>;
fetchParams?: Pick<FetchParams, 'body' | 'method' | 'headers'>;
queryOptions?: Omit<UseQueryOptions<ResourcePayload<R>, ResourceError<E>, D>, 'queryKey' | 'queryFn'>; queryOptions?: Omit<UseQueryOptions<ResourcePayload<R>, ResourceError<E>, D>, 'queryKey' | 'queryFn'>;
queryKey?: QueryKey; queryKey?: QueryKey;
} }
...@@ -27,11 +31,11 @@ export default function useApiQuery<R extends ResourceName, E = unknown, D = Res ...@@ -27,11 +31,11 @@ export default function useApiQuery<R extends ResourceName, E = unknown, D = Res
return useQuery<ResourcePayload<R>, ResourceError<E>, D>({ return useQuery<ResourcePayload<R>, ResourceError<E>, D>({
// eslint-disable-next-line @tanstack/query/exhaustive-deps // eslint-disable-next-line @tanstack/query/exhaustive-deps
queryKey: queryKey || getResourceKey(resource, { pathParams, queryParams }), queryKey: queryKey || getResourceKey(resource, { pathParams, queryParams }),
queryFn: async() => { queryFn: async({ signal }) => {
// all errors and error typing is handled by react-query // all errors and error typing is handled by react-query
// so error response will never go to the data // so error response will never go to the data
// that's why we are safe here to do type conversion "as Promise<ResourcePayload<R>>" // that's why we are safe here to do type conversion "as Promise<ResourcePayload<R>>"
return apiFetch(resource, { pathParams, queryParams, fetchParams }) as Promise<ResourcePayload<R>>; return apiFetch(resource, { pathParams, queryParams, fetchParams: { ...fetchParams, signal } }) as Promise<ResourcePayload<R>>;
}, },
...queryOptions, ...queryOptions,
}); });
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment