Docs
Cloudflare
CodeRabbit
Railway
SerpAPI
WorkOS
Netlify
Clerk
OpenRouter
AG Grid
Prisma
Sentry
Electric
Unkey
Cloudflare
CodeRabbit
Railway
SerpAPI
WorkOS
Netlify
Clerk
OpenRouter
AG Grid
Prisma
Sentry
Electric
Unkey
API Reference

useQuery

Function: useQuery()

Call Signature

ts
function useQuery<TQueryFnData, TError, TData, TQueryKey>(options, queryClient?): DefinedUseQueryResult<NoInfer<TData>, TError>;
function useQuery<TQueryFnData, TError, TData, TQueryKey>(options, queryClient?): DefinedUseQueryResult<NoInfer<TData>, TError>;

Defined in: preact-query/src/useQuery.ts:19

Type Parameters

TQueryFnData

TQueryFnData = unknown

TError

TError = Error

TData

TData = TQueryFnData

TQueryKey

TQueryKey extends readonly unknown[] = readonly unknown[]

Parameters

options

DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>

queryClient?

QueryClient

Returns

DefinedUseQueryResult<NoInfer<TData>, TError>

Call Signature

ts
function useQuery<TQueryFnData, TError, TData, TQueryKey>(options, queryClient?): UseQueryResult<NoInfer<TData>, TError>;
function useQuery<TQueryFnData, TError, TData, TQueryKey>(options, queryClient?): UseQueryResult<NoInfer<TData>, TError>;

Defined in: preact-query/src/useQuery.ts:29

Type Parameters

TQueryFnData

TQueryFnData = unknown

TError

TError = Error

TData

TData = TQueryFnData

TQueryKey

TQueryKey extends readonly unknown[] = readonly unknown[]

Parameters

options

UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>

queryClient?

QueryClient

Returns

UseQueryResult<NoInfer<TData>, TError>

Call Signature

ts
function useQuery<TQueryFnData, TError, TData, TQueryKey>(options, queryClient?): UseQueryResult<NoInfer<TData>, TError>;
function useQuery<TQueryFnData, TError, TData, TQueryKey>(options, queryClient?): UseQueryResult<NoInfer<TData>, TError>;

Defined in: preact-query/src/useQuery.ts:39

Type Parameters

TQueryFnData

TQueryFnData = unknown

TError

TError = Error

TData

TData = TQueryFnData

TQueryKey

TQueryKey extends readonly unknown[] = readonly unknown[]

Parameters

options

UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>

queryClient?

QueryClient

Returns

UseQueryResult<NoInfer<TData>, TError>