Interface: UseTRPCSuspenseInfiniteQueryOptions<TInput, TOutput, TError>
Extends
DistributiveOmit<UseSuspenseInfiniteQueryOptions<TOutput,TError,TOutput,TOutput,any,ExtractCursorType<TInput> >,"queryKey"|"initialPageParam">.TRPCUseQueryBaseOptions
Type parameters
| Parameter |
|---|
TInput |
TOutput |
TError |
Properties
_defaulted
optional_defaulted:boolean
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:586
Inherited from
DistributiveOmit._defaulted
_optimisticResults
optional_optimisticResults:"optimistic"|"isRestoring"
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:695
Inherited from
DistributiveOmit._optimisticResults
behavior
optionalbehavior:QueryBehavior<TOutput,TError,InfiniteData<TOutput,ExtractCursorType<TInput> >,any>
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:579
Inherited from
DistributiveOmit.behavior
gcTime
optionalgcTime: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.
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:571
Inherited from
DistributiveOmit.gcTime
getNextPageParam
getNextPageParam:
GetNextPageParamFunction<ExtractCursorType<TInput>,TOutput>
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.
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:610
Inherited from
DistributiveOmit.getNextPageParam
getPreviousPageParam
optionalgetPreviousPageParam:GetPreviousPageParamFunction<ExtractCursorType<TInput>,TOutput>
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.
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:605
Inherited from
DistributiveOmit.getPreviousPageParam
initialCursor
optionalinitialCursor:ExtractCursorType<TInput>
Source
packages/react-query/src/shared/hooks/types.ts:128
initialData
optionalinitialData:InfiniteData<TOutput,ExtractCursorType<TInput> > |InitialDataFunction<InfiniteData<TOutput,ExtractCursorType<TInput> > >
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:577
Inherited from
DistributiveOmit.initialData
initialDataUpdatedAt
optionalinitialDataUpdatedAt:number| () =>undefined|number
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:578
Inherited from
DistributiveOmit.initialDataUpdatedAt
maxPages
optionalmaxPages:number
Maximum number of pages to store in the data of an infinite query.
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:595
Inherited from
DistributiveOmit.maxPages
meta
optionalmeta:Record<string,unknown>
Additional payload to be stored on each query. Use this property to pass information that can be used in other places.
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:591
Inherited from
DistributiveOmit.meta
networkMode
optionalnetworkMode:NetworkMode
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:564
Inherited from
DistributiveOmit.networkMode
notifyOnChangeProps
optionalnotifyOnChangeProps: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.
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:672
Inherited from
DistributiveOmit.notifyOnChangeProps
persister
optionalpersister:QueryPersister<NoInfer<TOutput>,any,NoInfer<ExtractCursorType<TInput> > >
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:573
Inherited from
DistributiveOmit.persister
queryFn
optionalqueryFn: typeofskipToken|QueryFunction<TOutput,any,ExtractCursorType<TInput> >
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:572
Inherited from
DistributiveOmit.queryFn
queryHash
optionalqueryHash:string
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:574
Inherited from
DistributiveOmit.queryHash
queryKeyHashFn
optionalqueryKeyHashFn:QueryKeyHashFunction<any>
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:576
Inherited from
DistributiveOmit.queryKeyHashFn
refetchInterval
optionalrefetchInterval: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.
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:630
Inherited from
DistributiveOmit.refetchInterval
refetchIntervalInBackground
optionalrefetchIntervalInBackground:boolean
If set to true, the query will continue to refetch while their tab/window is in the background.
Defaults to false.
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:635
Inherited from
DistributiveOmit.refetchIntervalInBackground
refetchOnMount
optionalrefetchOnMount: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.
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:659
Inherited from
DistributiveOmit.refetchOnMount
refetchOnReconnect
optionalrefetchOnReconnect: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)
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:651
Inherited from
DistributiveOmit.refetchOnReconnect
refetchOnWindowFocus
optionalrefetchOnWindowFocus: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.
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:643
Inherited from
DistributiveOmit.refetchOnWindowFocus
retry
optionalretry: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.
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:562
Inherited from
DistributiveOmit.retry
retryDelay
optionalretryDelay:RetryDelayValue<TError>
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:563
Inherited from
DistributiveOmit.retryDelay
retryOnMount
optionalretryOnMount:boolean
If set to false, the query will not be retried on mount if it contains an error.
Defaults to true.
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:664
Inherited from
DistributiveOmit.retryOnMount
select
optionalselect: (data) =>TOutput
This option can be used to transform or select a part of the data returned by the query function.
Parameters
| Parameter | Type |
|---|---|
data | InfiniteData< TOutput, ExtractCursorType< TInput > > |
Returns
TOutput
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:684
Inherited from
DistributiveOmit.select
staleTime
optionalstaleTime:number
The time in milliseconds after data is considered stale.
If set to Infinity, the data will never be considered stale.
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:624
Inherited from
DistributiveOmit.staleTime
structuralSharing
optionalstructuralSharing: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.
Source
node_modules/.pnpm/@tanstack+query-core@5.40.0_patch_hash=7ja3td4letobdpqmvjcy7vchqm/node_modules/@tanstack/query-core/build/legacy/hydration-yBB_smkL.d.ts:585
Inherited from
DistributiveOmit.structuralSharing
trpc
optionaltrpc:TRPCReactRequestOptions
tRPC-related options
Source
packages/react-query/src/shared/hooks/types.ts:55
Inherited from
Generated using TypeDoc and typedoc-plugin-markdown