If false, failed queries will not retry by default.
If true, failed queries will retry infinitely.
If set to a number, e.g. 3, failed queries will retry until the failed query count meets that number.
defaults to 3 on the client and 0 on the server
retryOnMount: boolean
If set to false, the query will not be retried on mount if it contains an error. Defaults to true.
retryDelay: number | (retryAttempt: number, error: TError) => number
This function receives a retryAttempt integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
A function like attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000) applies exponential backoff.
A function like attempt => attempt * 1000 applies linear backoff.
staleTime: number | Infinity
Optional
Defaults to 0
The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
If set to Infinity, the data will never be considered stale
gcTime: number | Infinity
Defaults to 5 * 60 * 1000 (5 minutes) or Infinity during SSR
The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
Note: the maximum allowed time is about 24 days. See more.
If set to Infinity, will disable garbage collection
queryKeyHashFn: (queryKey: QueryKey) => string
Optional
If specified, this function is used to hash the queryKey to a string.
refetchInterval: number | false | ((query: Query) => number | false | undefined)
Optional
If set to a number, all queries will continuously refetch at this frequency in milliseconds
If set to a function, the function will be executed with the query to compute a frequency
refetchIntervalInBackground: boolean
Optional
If set to true, queries that are set to continuously refetch with a refetchInterval will continue to refetch while their tab/window is in the background
If set, the component will only re-render if any of the listed properties change.
If set to ['data', 'error'] for example, the component will only re-render when the data or error properties change.
If set to "all", the component will opt-out of smart tracking and re-render whenever a query is updated.
If 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.
select: (data: TData) => unknown
Optional
This option can be used to transform or select a part of the data returned by the query function. It affects the returned data value, but does not affect what gets stored in the query cache.
The select function will only run if data changed, or if the reference to the select function itself changes. To optimize, wrap the function in useCallback.
initialData: TData | () => TData
Optional
If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
If set to a function, the function will be called once during the shared/root query initialization, and be expected to synchronously return the initialData
Initial data is considered stale by default unless a staleTime has been set.
initialDatais persisted to the cache
initialDataUpdatedAt: number | (() => number | undefined)
Optional
If set, this value will be used as the time (in milliseconds) of when the initialData itself was last updated.
If set, this value will be used as the placeholder data for this particular query observer while the query is still in the pending state.
placeholderData is not persisted to the cache
If you provide a function for placeholderData, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.
If set to false, structural sharing between query results will be disabled.
If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.
Defaults to the global query config's throwOnError value, which is undefined
Set this to true if you want errors to be thrown in the render phase and propagate to the nearest error boundary
Set this to false to disable suspense's default behavior of throwing errors to the error boundary.
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)
meta: Record<string, unknown>
Optional
If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the query is available, and is also part of the QueryFunctionContext provided to the queryFn.
queryClient?: QueryClient,
Use this to use a custom QueryClient. Otherwise, the one from the nearest context will be used.
Returns
status: QueryStatus
Will be:
pending if there's no cached data and no query attempt was finished yet.
error if the query attempt resulted in an error. The corresponding error property has the error received from the attempted fetch
success if the query has received a response with no errors and is ready to display its data. The corresponding data property on the query is the data received from the successful fetch or if the query's enabled property is set to false and has not been fetched yet data is the first initialData supplied to the query on initialization.
isPending: boolean
A derived boolean from the status variable above, provided for convenience.
isSuccess: boolean
A derived boolean from the status variable above, provided for convenience.
isError: boolean
A derived boolean from the status variable above, provided for convenience.
isLoadingError: boolean
Will be true if the query failed while fetching for the first time.
isRefetchError: boolean
Will be true if the query failed while refetching.
data: TData
Defaults to undefined.
The last successfully resolved data for the query.
dataUpdatedAt: number
The timestamp for when the query most recently returned the status as "success".
error: null | TError
Defaults to null
The error object for the query, if an error was thrown.
errorUpdatedAt: number
The timestamp for when the query most recently returned the status as "error".
isStale: boolean
Will be true if the data in the cache is invalidated or if the data is older than the given staleTime.
isPlaceholderData: boolean
Will be true if the data shown is the placeholder data.
isFetched: boolean
Will be true if the query has been fetched.
isFetchedAfterMount: boolean
Will be true if the query has been fetched after the component mounted.
This property can be used to not show any previously cached data.
fetchStatus: FetchStatus
fetching: Is true whenever the queryFn is executing, which includes initial pending as well as background refetches.
paused: The query wanted to fetch, but has been paused.