Interface: UndefinedTRPCQueryOptionsIn<TQueryFnData, TData, TError>

QueryOptions API helpers

Extends

• DistributiveOmit<UndefinedInitialDataOptions<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TData>, TRPCQueryKey>, TRPCOptionOverrides>.TRPCQueryBaseOptions

Type Parameters

Type Parameter
TQueryFnData
TData
TError

Properties

_defaulted?

optional _defaulted: boolean

Inherited from

DistributiveOmit._defaulted

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:593

---

_optimisticResults?

optional _optimisticResults: "optimistic" | "isRestoring"

Inherited from

DistributiveOmit._optimisticResults

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:704

---

behavior?

optional behavior: QueryBehavior<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TQueryFnData>, TRPCQueryKey>

Inherited from

DistributiveOmit.behavior

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:586

---

enabled?

optional enabled: Enabled<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TQueryFnData>, TRPCQueryKey>

Set this to false or a function that returns false to disable automatic refetching when the query mounts or changes query keys. To refetch the query, use the refetch method returned from the useQuery instance. Accepts a boolean or function that returns a boolean. Defaults to true.

Inherited from

DistributiveOmit.enabled

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:627

---

experimental_prefetchInRender?

optional experimental_prefetchInRender: boolean

Enable prefetching during rendering

Inherited from

DistributiveOmit.experimental_prefetchInRender

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:708

---

gcTime?

optional gcTime: number

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.

Inherited from

DistributiveOmit.gcTime

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:578

---

initialData?

optional initialData: (coerceAsyncIterableToArray<TQueryFnData> | InitialDataFunction<coerceAsyncIterableToArray<TQueryFnData>>) & (NonUndefinedGuard<...> | InitialDataFunction<...>)

Inherited from

DistributiveOmit.initialData

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:584

---

initialDataUpdatedAt?

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

Inherited from

DistributiveOmit.initialDataUpdatedAt

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:585

---

maxPages?

optional maxPages: number

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

Inherited from

DistributiveOmit.maxPages

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:602

---

meta?

optional meta: Record<string, unknown>

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

Inherited from

DistributiveOmit.meta

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:598

---

networkMode?

optional networkMode: NetworkMode

Inherited from

DistributiveOmit.networkMode

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:571

---

notifyOnChangeProps?

optional notifyOnChangeProps: NotifyOnChangeProps

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

Inherited from

DistributiveOmit.notifyOnChangeProps

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:681

---

persister()?

optional persister: (queryFn, context, query) => NoInfer<coerceAsyncIterableToArray<TQueryFnData>> | Promise<NoInfer<coerceAsyncIterableToArray<TQueryFnData>>>

Parameters

Parameter	Type	Description
queryFn	QueryFunction<NoInfer<coerceAsyncIterableToArray<TQueryFnData>>, TRPCQueryKey, never>	-
context	object	-
context.direction?	unknown	Deprecated if you want access to the direction, you can add it to the pageParam
context.meta	undefined | Record<string, unknown>	-
context.pageParam?	unknown	-
context.queryKey	TRPCQueryKey	-
context.signal	AbortSignal	-
query	Query<unknown, Error, unknown, QueryKey>	-

Returns

NoInfer<coerceAsyncIterableToArray<TQueryFnData>> | Promise<NoInfer<coerceAsyncIterableToArray<TQueryFnData>>>

Inherited from

DistributiveOmit.persister

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:580

---

placeholderData?

optional placeholderData: NonFunctionGuard<coerceAsyncIterableToArray<TQueryFnData>> | PlaceholderDataFunction<NonFunctionGuard<coerceAsyncIterableToArray<TQueryFnData>>, TError, NonFunctionGuard<coerceAsyncIterableToArray<TQueryFnData>>, TRPCQueryKey>

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

Inherited from

DistributiveOmit.placeholderData

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:703

---

queryKeyHashFn?

optional queryKeyHashFn: QueryKeyHashFunction<TRPCQueryKey>

Inherited from

DistributiveOmit.queryKeyHashFn

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:583

---

refetchInterval?

optional refetchInterval: number | false | (query) => undefined | number | false

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

Inherited from

DistributiveOmit.refetchInterval

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:639

---

refetchIntervalInBackground?

optional refetchIntervalInBackground: boolean

If set to true, the query will continue to refetch while their tab/window is in the background. Defaults to false.

Inherited from

DistributiveOmit.refetchIntervalInBackground

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:644

---

refetchOnMount?

optional refetchOnMount: boolean | "always" | (query) => boolean | "always"

If 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 refetch. 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.

Inherited from

DistributiveOmit.refetchOnMount

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:668

---

refetchOnReconnect?

optional refetchOnReconnect: boolean | "always" | (query) => boolean | "always"

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

Inherited from

DistributiveOmit.refetchOnReconnect

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:660

---

refetchOnWindowFocus?

optional refetchOnWindowFocus: boolean | "always" | (query) => boolean | "always"

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

Inherited from

DistributiveOmit.refetchOnWindowFocus

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:652

---

retry?

optional retry: RetryValue<TError>

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

Inherited from

DistributiveOmit.retry

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:569

---

retryDelay?

optional retryDelay: RetryDelayValue<TError>

Inherited from

DistributiveOmit.retryDelay

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:570

---

retryOnMount?

optional retryOnMount: boolean

If set to false, the query will not be retried on mount if it contains an error. Defaults to true.

Inherited from

DistributiveOmit.retryOnMount

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:673

---

select()?

optional select: (data) => coerceAsyncIterableToArray<TData>

This option can be used to transform or select a part of the data returned by the query function.

Parameters

Parameter	Type
data	coerceAsyncIterableToArray<TQueryFnData>

Returns

coerceAsyncIterableToArray<TData>

Inherited from

DistributiveOmit.select

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:693

---

staleTime?

optional staleTime: StaleTime<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TQueryFnData>, TRPCQueryKey>

The time in milliseconds after data is considered stale. If set to Infinity, the data will never be considered stale. If set to a function, the function will be executed with the query to compute a staleTime.

Inherited from

DistributiveOmit.staleTime

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:633

---

structuralSharing?

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

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

DistributiveOmit.structuralSharing

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:592

---

throwOnError?

optional throwOnError: ThrowOnError<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TQueryFnData>, TRPCQueryKey>

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

Inherited from

DistributiveOmit.throwOnError

Defined in

node_modules/.pnpm/@tanstack+query-core@5.59.13/node_modules/@tanstack/query-core/build/legacy/hydration-mKPlgzt9.d.ts:689

---

trpc?

optional trpc: TRPCReactRequestOptions

tRPC-related options

Inherited from

TRPCQueryBaseOptions.trpc

Defined in

packages/react-query/src/shared/types.ts:28