react-qc-v
Version:
Lightweight @tanstack/react-query wrapper that provides error/loading, and more...
80 lines (79 loc) • 7.93 kB
TypeScript
import { QueryClient, QueryKey, UseInfiniteQueryOptions, UseInfiniteQueryResult, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
import { ReactNode } from 'react';
import type { Body, Client, ExcludeFirst, ExcludeFirstTwo, Extractable, LoadingProps, Path, RenderProps, Variables } from '../../common/src';
export declare function wrapUseQueryWithExtensions<TVariables extends QueryKey = QueryKey, TQueryFnData = any, TError = any, TData = TQueryFnData>(defaultOptions: Omit<UseQueryOptions<TQueryFnData, TError, TData, TVariables>, 'queryKey'> | UseQueryOptions<TQueryFnData, TError, TData, TVariables>, keyFn?: any): {
<T = TData>(props: {
path: Path<TVariables>;
body: Body<TVariables>;
variables?: Variables<ExcludeFirstTwo<TVariables>> | undefined;
} & LoadingProps & RenderProps<T, UseQueryResult<T, TError>> & Client & Omit<UseQueryOptions<TQueryFnData, TError, T, TVariables>, "queryKey">): ReactNode;
<T_1 = TData>(props: {
path: Path<TVariables>;
variables?: Variables<ExcludeFirst<TVariables>> | undefined;
} & LoadingProps & RenderProps<T_1, UseQueryResult<T_1, TError>> & Client & Omit<UseQueryOptions<TQueryFnData, TError, T_1, TVariables>, "queryKey">): ReactNode;
<T_2 = TData>(props: {
variables?: Variables<TVariables> | Extractable<TVariables> | undefined;
} & LoadingProps & RenderProps<T_2, UseQueryResult<T_2, TError>> & Client & Omit<UseQueryOptions<TQueryFnData, TError, T_2, TVariables>, "queryKey">): ReactNode;
} & {
use: <T_3 = TData>(variables: Variables<TVariables>, options?: Omit<UseQueryOptions<TQueryFnData, TError, T_3, TVariables>, "queryKey"> | undefined, client?: QueryClient | undefined) => UseQueryResult<T_3, TError>;
useKeyFn: (variables: Variables<TVariables>) => any;
keyFn: any;
defaultOptions: UseQueryOptions<TQueryFnData, TError, TData, TVariables> | Omit<UseQueryOptions<TQueryFnData, TError, TData, TVariables>, "queryKey">;
};
export declare function wrapUseQuery<TVariables extends QueryKey = QueryKey, TQueryFnData = any, TError = any, TData = TQueryFnData>(defaultOptions: Omit<UseQueryOptions<TQueryFnData, TError, TData, TVariables>, 'queryKey'> | UseQueryOptions<TQueryFnData, TError, TData, TVariables>, keyFn?: any): {
<T = TData>(props: {
path: Path<TVariables>;
body: Body<TVariables>;
variables?: Variables<ExcludeFirstTwo<TVariables>> | undefined;
} & LoadingProps & RenderProps<T, UseQueryResult<T, TError>> & Client & Omit<UseQueryOptions<TQueryFnData, TError, T, TVariables>, "queryKey">): ReactNode;
<T_1 = TData>(props: {
path: Path<TVariables>;
variables?: Variables<ExcludeFirst<TVariables>> | undefined;
} & LoadingProps & RenderProps<T_1, UseQueryResult<T_1, TError>> & Client & Omit<UseQueryOptions<TQueryFnData, TError, T_1, TVariables>, "queryKey">): ReactNode;
<T_2 = TData>(props: {
variables?: Variables<TVariables> | Extractable<TVariables> | undefined;
} & LoadingProps & RenderProps<T_2, UseQueryResult<T_2, TError>> & Client & Omit<UseQueryOptions<TQueryFnData, TError, T_2, TVariables>, "queryKey">): ReactNode;
} & {
use: <T_3 = TData>(variables: Variables<TVariables>, options?: Omit<UseQueryOptions<TQueryFnData, TError, T_3, TVariables>, "queryKey"> | undefined, client?: QueryClient) => UseQueryResult<T_3, TError>;
useKeyFn: (variables: Variables<TVariables>) => any;
keyFn: any;
defaultOptions: UseQueryOptions<TQueryFnData, TError, TData, TVariables> | Omit<UseQueryOptions<TQueryFnData, TError, TData, TVariables>, "queryKey">;
};
export declare function wrapUseInfiniteQueryWithExtensions<TVariables extends QueryKey = QueryKey, TQueryFnData = any, TError = any, TData = TQueryFnData, TQueryData = TQueryFnData, TPageParam = unknown>(defaultOptions: Omit<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TVariables, TPageParam>, 'queryKey'> | UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TVariables, TPageParam>, keyFn?: any): {
<T = TData>(props: {
path: Path<TVariables>;
body: Body<TVariables>;
variables?: Variables<ExcludeFirstTwo<TVariables>> | undefined;
} & LoadingProps & RenderProps<T, UseInfiniteQueryResult<T, TError>> & Client & Omit<UseInfiniteQueryOptions<TQueryFnData, TError, T, TQueryData, TVariables, TPageParam>, "queryKey" | "getNextPageParam" | "initialPageParam">): ReactNode;
<T_1 = TData>(props: {
path: Path<TVariables>;
variables?: Variables<ExcludeFirst<TVariables>> | undefined;
} & LoadingProps & RenderProps<T_1, UseInfiniteQueryResult<T_1, TError>> & Client & Omit<UseInfiniteQueryOptions<TQueryFnData, TError, T_1, TQueryData, TVariables, TPageParam>, "queryKey" | "getNextPageParam" | "initialPageParam">): ReactNode;
<T_2 = TData>(props: {
variables?: Variables<TVariables> | Extractable<TVariables> | undefined;
} & LoadingProps & RenderProps<T_2, UseInfiniteQueryResult<T_2, TError>> & Client & Omit<UseInfiniteQueryOptions<TQueryFnData, TError, T_2, TQueryData, TVariables, TPageParam>, "queryKey" | "getNextPageParam" | "initialPageParam">): ReactNode;
} & {
use: <T_3 = TData>(variables: Variables<TVariables>, options?: Omit<UseInfiniteQueryOptions<TQueryFnData, TError, T_3, TQueryData, TVariables, TPageParam>, "queryKey" | "getNextPageParam" | "initialPageParam"> | undefined, client?: QueryClient | undefined) => UseInfiniteQueryResult<T_3, TError>;
useKeyFn: (variables: Variables<TVariables>) => any;
keyFn: any;
defaultOptions: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TVariables, TPageParam> | Omit<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TVariables, TPageParam>, "queryKey">;
};
export declare function wrapUseInfiniteQuery<TVariables extends QueryKey = QueryKey, TQueryFnData = any, TError = any, TData = TQueryFnData, TQueryData = TQueryFnData, TPageParam = unknown>(defaultOptions: Omit<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TVariables, TPageParam>, 'queryKey'> | UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TVariables, TPageParam>, keyFn?: any): {
<T = TData>(props: {
path: Path<TVariables>;
body: Body<TVariables>;
variables?: Variables<ExcludeFirstTwo<TVariables>> | undefined;
} & LoadingProps & RenderProps<T, UseInfiniteQueryResult<T, TError>> & Client & Omit<UseInfiniteQueryOptions<TQueryFnData, TError, T, TQueryData, TVariables, TPageParam>, "queryKey" | "getNextPageParam" | "initialPageParam">): ReactNode;
<T_1 = TData>(props: {
path: Path<TVariables>;
variables?: Variables<ExcludeFirst<TVariables>> | undefined;
} & LoadingProps & RenderProps<T_1, UseInfiniteQueryResult<T_1, TError>> & Client & Omit<UseInfiniteQueryOptions<TQueryFnData, TError, T_1, TQueryData, TVariables, TPageParam>, "queryKey" | "getNextPageParam" | "initialPageParam">): ReactNode;
<T_2 = TData>(props: {
variables?: Variables<TVariables> | Extractable<TVariables> | undefined;
} & LoadingProps & RenderProps<T_2, UseInfiniteQueryResult<T_2, TError>> & Client & Omit<UseInfiniteQueryOptions<TQueryFnData, TError, T_2, TQueryData, TVariables, TPageParam>, "queryKey" | "getNextPageParam" | "initialPageParam">): ReactNode;
} & {
use: <T_3 = TData>(variables: Variables<TVariables>, options?: Omit<UseInfiniteQueryOptions<TQueryFnData, TError, T_3, TQueryData, TVariables, TPageParam>, "queryKey" | "getNextPageParam" | "initialPageParam"> | undefined, client?: QueryClient) => UseInfiniteQueryResult<T_3, TError>;
useKeyFn: (variables: Variables<TVariables>) => any;
keyFn: any;
defaultOptions: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TVariables, TPageParam> | Omit<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TVariables, TPageParam>, "queryKey">;
};