Optional
_defaultedOptional
_optimisticOptional
behaviorOptional
cacheOptional
enabledOptional
getThis function can be set to automatically get the next cursor for infinite queries.
The result will also be used to determine the value of hasNextPage
.
Optional
getThis function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of hasPreviousPage
.
Optional
initialOptional
initialOptional
isThis callback will be removed in the next major version. You can achieve the same functionality by passing a function to structuralSharing
instead.
Optional
keepSet this to true
to keep the previous data
when fetching based on a new query key.
Defaults to false
.
Optional
metaAdditional payload to be stored on each query. Use this property to pass information that can be used in other places.
Optional
networkOptional
notifyIf set, the component will only re-render if any of the listed properties change.
When set to ['data', 'error']
, the component will only re-render when the data
or error
properties change.
When set to 'all'
, the component will re-render whenever a query is updated.
When set to a function, the function will be executed to compute the list of properties.
By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.
Optional
onThis callback will fire if the query encounters an error and will be passed the error.
This callback will be removed in the next major version.
Optional
onThis callback will fire any time the query is either successfully fetched or errors and be passed either the data or error.
This callback will be removed in the next major version.
Optional
onThis callback will fire any time the query successfully fetches new data.
This callback will be removed in the next major version.
Optional
placeholderIf set, this value will be used as the placeholder data for this particular query observer while the query is still in the loading
data and no initialData has been provided.
Optional
queryOptional
queryOptional
queryOptional
queryOptional
refetchIf set to a number, the query will continuously refetch at this frequency in milliseconds.
If set to a function, the function will be executed with the latest data and query to compute a frequency
Defaults to false
.
Optional
refetchIf set to true
, the query will continue to refetch while their tab/window is in the background.
Defaults to false
.
Optional
refetchIf set to true
, the query will refetch on mount if the data is stale.
If set to false
, will disable additional instances of a query to trigger background refetches.
If set to 'always'
, the query will always refetch on mount.
If set to a function, the function will be executed with the latest data and query to compute the value
Defaults to true
.
Optional
refetchIf set to true
, the query will refetch on reconnect if the data is stale.
If set to false
, the query will not refetch on reconnect.
If set to 'always'
, the query will always refetch on reconnect.
If set to a function, the function will be executed with the latest data and query to compute the value.
Defaults to the value of networkOnline
(true
)
Optional
refetchIf set to true
, the query will refetch on window focus if the data is stale.
If set to false
, the query will not refetch on window focus.
If set to 'always'
, the query will always refetch on window focus.
If set to a function, the function will be executed with the latest data and query to compute the value.
Defaults to true
.
Optional
retryIf false
, failed queries will not retry by default.
If true
, failed queries will retry infinitely., failureCount: num
If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number.
If set to a function (failureCount, error) => boolean
failed queries will retry until the function returns false.
Optional
retryOptional
retryIf set to false
, the query will not be retried on mount if it contains an error.
Defaults to true
.
Optional
selectThis option can be used to transform or select a part of the data returned by the query function.
Optional
staleThe time in milliseconds after data is considered stale.
If set to Infinity
, the data will never be considered stale.
Optional
structuralSet this to false
to disable structural sharing between query results.
Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom structural sharing logic.
Defaults to true
.
Optional
suspenseIf set to true
, the query will suspend when status === 'loading'
and throw errors when status === 'error'
.
Defaults to false
.
Optional
useWhether errors should be thrown instead of setting the error
property.
If set to true
or suspense
is true
, all errors will be thrown to the error boundary.
If set to false
and suspense
is false
, errors are returned as state.
If set to a function, it will be passed the error and the query, and it should return a boolean indicating whether to show the error in an error boundary (true
) or return the error as state (false
).
Defaults to false
.
Generated using TypeDoc
Set this to
false
to disable automatic refetching when the query mounts or changes query keys. To refetch the query, use therefetch
method returned from theuseQuery
instance. Defaults totrue
.