API Reference
Rockets React API
react-data-provider
functions
useQuery

Function: useQuery()

useQuery<TQueryData, TError>(asyncFn, immediate, options?, arg?): object

Type Parameters

Type ParameterDefault type
TQueryData-
TErrorunknown

Parameters

ParameterTypeDefault value
asyncFnAsyncFunctionundefined
immediatebooleanfalse
options?DataProviderRequestOptions<TQueryData, TError>undefined
arg?unknownundefined

Returns

object

NameType
dataTQueryData
errorTError
execute(_arg?) => Promise<void>
isPendingboolean
refresh() => Promise<void>
statusAsyncStatus

Defined in

index.tsx:11 (opens in a new tab)