QueryExecuteOptions

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

Extends#

• WithRequired<QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey, TPageParam>, "queryKey">

Type Parameters#

TQueryFnData#

TQueryFnData = unknown

TError#

TError = DefaultError

TData#

TData = TQueryFnData

TQueryData#

TQueryData = TQueryFnData

TQueryKey#

TQueryKey extends QueryKey = QueryKey

TPageParam#

TPageParam = never

Properties#

gcTime?#

optional gcTime: number;

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

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.

Inherited from#

WithRequired.gcTime

initialData?#

optional initialData: 
  | TQueryData
| InitialDataFunction<TQueryData>;

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

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.

Inherited from#

WithRequired.initialData

initialDataUpdatedAt?#

optional initialDataUpdatedAt: number | () => number | undefined;

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

If set, this value will be used as the time (in milliseconds) of when the initialData itself was last updated.

Inherited from#

WithRequired.initialDataUpdatedAt

initialPageParam?#

optional initialPageParam: undefined;

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

maxPages?#

optional maxPages: number;

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

Maximum number of pages to store in the data of an infinite query.

Inherited from#

WithRequired.maxPages

meta?#

optional meta: Record<string, unknown>;

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

Additional payload to be stored on each query. Use this property to pass information that can be used in other places.

Inherited from#

WithRequired.meta

networkMode?#

optional networkMode: NetworkMode;

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

Controls whether a query is allowed to run based on the current network connectivity.

Defaults to 'online'.

See#

Network Mode for more information.

Inherited from#

WithRequired.networkMode

persister?#

optional persister: QueryPersister<TQueryFnData, NoInfer<TQueryKey>, TPageParam>;

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

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.

Inherited from#

WithRequired.persister

queryFn?#

optional queryFn: 
  | typeof skipToken
| QueryFunction<TQueryFnData, TQueryKey, TPageParam>;

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

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.

Inherited from#

WithRequired.queryFn

queryHash?#

optional queryHash: string;

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

The hashed form of queryKey, computed with queryKeyHashFn (or the default hashing function otherwise). Used as the actual cache key internally.

Inherited from#

WithRequired.queryHash

queryKey#

queryKey: TQueryKey & object;

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

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).

Inherited from#

WithRequired.queryKey

queryKeyHashFn?#

optional queryKeyHashFn: QueryKeyHashFunction<TQueryKey>;

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

If specified, this function is used to hash the queryKey to a string.

Inherited from#

WithRequired.queryKeyHashFn

retry?#

optional retry: RetryValue<TError>;

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

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.

Inherited from#

WithRequired.retry

retryDelay?#

optional retryDelay: RetryDelayValue<TError>;

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

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.

Inherited from#

WithRequired.retryDelay

select()?#

optional select: (data) => TData;

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

Parameters#

data#

TQueryData

Returns#

TData

staleTime?#

optional staleTime: StaleTimeFunction<TQueryFnData, TError, TQueryData, TQueryKey>;

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

The time in milliseconds after data is considered stale. If the data is fresh it will be returned from the cache.

structuralSharing?#

optional structuralSharing: boolean | (oldData, newData) => unknown;

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

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.

Defaults to true.

Inherited from#

WithRequired.structuralSharing