@gravity-ui/data-source
Version:
A wrapper around data fetching
8 lines (7 loc) • 965 B
TypeScript
import type { DefaultError, Query, QueryFunction, QueryKey, SkipToken } from '@tanstack/react-query';
import type { RefetchInterval } from '../types/refetch-interval';
export interface UseRefetchIntervalResult<TQueryFnData = unknown, TError = DefaultError, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> {
refetchInterval?: number | false | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => number | false | undefined);
queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam> | SkipToken;
}
export declare const useRefetchInterval: <TQueryFnData = unknown, TError = Error, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(refetchInterval?: RefetchInterval<TQueryFnData, TError, TQueryData, TQueryKey>, queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam> | SkipToken) => UseRefetchIntervalResult<TQueryFnData, TError, TQueryData, TQueryKey, TPageParam>;