Skip to content

FetchQueryOptions.md

Latest commit

 

History

History
59 lines (40 loc) · 6.62 KB

FetchQueryOptions.md

File metadata and controls

59 lines (40 loc) · 6.62 KB
Raw
id FetchQueryOptions
title FetchQueryOptions

Defined in: packages/query-core/src/types.ts:615

Deprecated

Extends

Extended by

Type Parameters

TQueryFnData

TQueryFnData = unknown

TError

TError = DefaultError

TData

TData = TQueryFnData

TQueryKey

TQueryKey extends QueryKey = QueryKey

TPageParam

TPageParam = never

Properties

Property Type Default value Description
gcTime? number undefined 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. Setting it to Infinity will disable garbage collection. Defaults to 5 * 60 * 1000 (5 minutes), or Infinity during SSR. Note: the maximum allowed time is about 24 days, imposed by setTimeout's 32-bit signed integer delay — see timeoutManager.setTimeoutProvider for a workaround.
initialData? TData | () => TData | undefined undefined 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 initial data. Initial data is considered stale by default unless a staleTime has been set. initialData is persisted to the cache.
initialDataUpdatedAt? number | () => number | undefined undefined If set, this value will be used as the time (in milliseconds) of when the initialData itself was last updated.
initialPageParam? undefined undefined -
maxPages? number undefined Maximum number of pages to store in the data of an infinite query.
meta? Record<string, unknown> undefined Additional payload to be stored on each query. Use this property to pass information that can be used in other places.
networkMode? "online" | "always" | "offlineFirst" 'online' Controls whether a query is allowed to run based on the current network connectivity. See Network Mode for more information.
persister? (queryFn: (context: QueryFunctionContext<NoInfer<TQueryKey>, TPageParam>) => TQueryFnData | Promise<TQueryFnData>, context: object, query: Query) => TQueryFnData | Promise<TQueryFnData> undefined This option can be used to persist the result of a query to an external storage, bypassing the need to actually call the queryFn. Useful for persisting a query's data across e.g. server/client boundaries.
queryFn? | typeof skipToken | (context: QueryFunctionContext<TQueryKey, TPageParam>) => TQueryFnData | Promise<TQueryFnData> undefined The function that the query will use to request data. Required, unless a default query function has been set via queryClient.setQueryDefaults or queryClient.setDefaultOptions. Receives a QueryFunctionContext. Must return a promise that will either resolve data or throw an error. The data cannot be undefined.
queryHash? string undefined The hashed form of queryKey, computed with queryKeyHashFn (or the default hashing function otherwise). Used as the actual cache key internally.
queryKey TQueryKey & object undefined The query key to use for this query. The query key will be hashed into a stable hash. See Query Keys for more information. The query will automatically update when this key changes (as long as enabled is not set to false).
queryKeyHashFn? (queryKey: TQueryKey) => string undefined If specified, this function is used to hash the queryKey to a string.
retry? | number | false | true | (failureCount: number, error: TError) => boolean undefined If false, failed queries will not retry by default. If true, failed queries will retry infinitely. 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. Defaults to 3 on the client and 0 on the server.
retryDelay? number | (failureCount: number, error: TError) => number undefined 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. Defaults to a function that applies exponential backoff, capped at 30 seconds.
staleTime? | number | "static" | (query: Query<TQueryFnData, TError, TData, TQueryKey>) => number | "static" undefined The time in milliseconds after data is considered stale. If the data is fresh it will be returned from the cache.
structuralSharing? boolean | (oldData: unknown, newData: unknown) => unknown true Set 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.