Skip to main content
Version: 11.x

Interface: DefinedTRPCInfiniteQueryOptionsIn<TInput, TQueryFnData, TData, TError>

Defined in: packages/react-query/src/shared/types.ts:154

Extends​

Type Parameters​

Type Parameter
TInput
TQueryFnData
TData
TError

Properties​

_defaulted?​

optional _defaulted: boolean

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:609

Inherited from​

DistributiveOmit._defaulted

_optimisticResults?​

optional _optimisticResults: "optimistic" | "isRestoring"

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:721

Inherited from​

DistributiveOmit._optimisticResults

behavior?​

optional behavior: QueryBehavior<TQueryFnData, TError, InfiniteData<TQueryFnData, null | NonNullable<ExtractCursorType<TInput>>>, TRPCQueryKey>

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:602

Inherited from​

DistributiveOmit.behavior

enabled?​

optional enabled: Enabled<TQueryFnData, TError, InfiniteData<TQueryFnData, null | NonNullable<ExtractCursorType<TInput>>>, TRPCQueryKey>

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:643

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

experimental_prefetchInRender?​

optional experimental_prefetchInRender: boolean

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:725

Enable prefetching during rendering

Inherited from​

DistributiveOmit.experimental_prefetchInRender

gcTime?​

optional gcTime: number

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:594

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

getNextPageParam​

getNextPageParam: GetNextPageParamFunction<null | NonNullable<ExtractCursorType<TInput>>, TQueryFnData>

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:633

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

Inherited from​

DistributiveOmit.getNextPageParam

getPreviousPageParam?​

optional getPreviousPageParam: GetPreviousPageParamFunction<null | NonNullable<ExtractCursorType<TInput>>, TQueryFnData>

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:628

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

Inherited from​

DistributiveOmit.getPreviousPageParam

initialCursor?​

optional initialCursor: null | NonNullable<ExtractCursorType<TInput>>

Defined in: packages/react-query/src/shared/types.ts:170

initialData​

initialData: undefined | (InfiniteData<TQueryFnData, NonNullable<ExtractCursorType<TInput>> | null> | InitialDataFunction<InfiniteData<TQueryFnData, NonNullable<...> | null>>) & (InfiniteData<...> | (() => InfiniteData<...>))

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:600

Inherited from​

DistributiveOmit.initialData

initialDataUpdatedAt?​

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

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:601

Inherited from​

DistributiveOmit.initialDataUpdatedAt

maxPages?​

optional maxPages: number

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:618

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

Inherited from​

DistributiveOmit.maxPages

meta?​

optional meta: Record<string, unknown>

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:614

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

networkMode?​

optional networkMode: NetworkMode

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:587

Inherited from​

DistributiveOmit.networkMode

notifyOnChangeProps?​

optional notifyOnChangeProps: NotifyOnChangeProps

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:698

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

persister?​

optional persister: QueryPersister<NoInfer<TQueryFnData>, TRPCQueryKey, NoInfer<null | NonNullable<ExtractCursorType<TInput>>>>

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:596

Inherited from​

DistributiveOmit.persister

placeholderData?​

optional placeholderData: InfiniteData<TQueryFnData, null | NonNullable<ExtractCursorType<TInput>>> | PlaceholderDataFunction<InfiniteData<TQueryFnData, null | NonNullable<ExtractCursorType<TInput>>>, TError, InfiniteData<TQueryFnData, null | NonNullable<ExtractCursorType<TInput>>>, TRPCQueryKey>

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:720

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

queryKeyHashFn?​

optional queryKeyHashFn: QueryKeyHashFunction<TRPCQueryKey>

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:599

Inherited from​

DistributiveOmit.queryKeyHashFn

refetchInterval?​

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

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:656

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

refetchIntervalInBackground?​

optional refetchIntervalInBackground: boolean

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:661

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

refetchOnMount?​

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

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:685

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

refetchOnReconnect?​

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

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:677

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

refetchOnWindowFocus?​

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

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:669

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

retry?​

optional retry: RetryValue<TError>

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:585

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

retryDelay?​

optional retryDelay: RetryDelayValue<TError>

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:586

Inherited from​

DistributiveOmit.retryDelay

retryOnMount?​

optional retryOnMount: boolean

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:690

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

Inherited from​

DistributiveOmit.retryOnMount

select()?​

optional select: (data) => InfiniteData

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:710

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

Parameters​

ParameterType
dataInfiniteData

Returns​

InfiniteData

Inherited from​

DistributiveOmit.select

staleTime?​

optional staleTime: StaleTime<TQueryFnData, TError, InfiniteData<TQueryFnData, null | NonNullable<ExtractCursorType<TInput>>>, TRPCQueryKey>

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:650

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. Defaults to 0.

Inherited from​

DistributiveOmit.staleTime

structuralSharing?​

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

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:608

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

subscribed?​

optional subscribed: boolean

Defined in: node_modules/.pnpm/@tanstack+react-query@5.66.0_react@19.0.0/node_modules/@tanstack/react-query/build/legacy/types.d.ts:24

Set this to false to unsubscribe this observer from updates to the query cache. Defaults to true.

Inherited from​

DistributiveOmit.subscribed

throwOnError?​

optional throwOnError: ThrowOnError<TQueryFnData, TError, InfiniteData<TQueryFnData, null | NonNullable<ExtractCursorType<TInput>>>, TRPCQueryKey>

Defined in: node_modules/.pnpm/@tanstack+query-core@5.66.0/node_modules/@tanstack/query-core/build/legacy/hydration-De1u5VYH.d.ts:706

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

trpc?​

optional trpc: TRPCReactRequestOptions

Defined in: packages/react-query/src/shared/types.ts:25

tRPC-related options

Inherited from​

TRPCQueryBaseOptions.trpc