Interface: UseTRPCPrefetchQueryOptions<TOutput, TData, TError>
Defined in: packages/react-query/src/shared/hooks/types.ts:79
Extends
DistributiveOmit
<FetchQueryOptions
<TOutput
,TError
,TData
,any
>,"queryKey"
>.TRPCUseQueryBaseOptions
Type Parameters
Type Parameter |
---|
TOutput |
TData |
TError |
Properties
_defaulted?
optional
_defaulted:boolean
Defined in: node_modules/.pnpm/@tanstack+query-core@5.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:617
Inherited from
DistributiveOmit._defaulted
behavior?
optional
behavior:QueryBehavior
<TOutput
,TError
,TData
,any
>
Defined in: node_modules/.pnpm/@tanstack+query-core@5.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:610
Inherited from
DistributiveOmit.behavior
gcTime?
optional
gcTime:number
Defined in: node_modules/.pnpm/@tanstack+query-core@5.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:602
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
initialData?
optional
initialData:TData
|InitialDataFunction
<TData
>
Defined in: node_modules/.pnpm/@tanstack+query-core@5.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:608
Inherited from
DistributiveOmit.initialData
initialDataUpdatedAt?
optional
initialDataUpdatedAt:number
| () =>undefined
|number
Defined in: node_modules/.pnpm/@tanstack+query-core@5.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:609
Inherited from
DistributiveOmit.initialDataUpdatedAt
initialPageParam?
optional
initialPageParam:undefined
Defined in: node_modules/.pnpm/@tanstack+query-core@5.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:743
Inherited from
DistributiveOmit.initialPageParam
maxPages?
optional
maxPages:number
Defined in: node_modules/.pnpm/@tanstack+query-core@5.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:626
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.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:622
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.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:595
Inherited from
DistributiveOmit.networkMode
persister()?
optional
persister: (queryFn
,context
,query
) =>NoInfer
<TOutput
> |Promise
<NoInfer
<TOutput
>>
Defined in: node_modules/.pnpm/@tanstack+query-core@5.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:604
Parameters
Parameter | Type | Description |
---|---|---|
queryFn | QueryFunction <NoInfer <TOutput >, any , never > | - |
context | { client : QueryClient ; direction : unknown ; meta : undefined | Record <string , unknown >; pageParam : unknown ; queryKey : any ; signal : AbortSignal ; } | - |
context.client | QueryClient | - |
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 | any | - |
context.signal | AbortSignal | - |
query | Query | - |
Returns
NoInfer
<TOutput
> | Promise
<NoInfer
<TOutput
>>
Inherited from
DistributiveOmit.persister
queryFn?
optional
queryFn: typeofskipToken
|QueryFunction
<TOutput
,any
,never
>
Defined in: node_modules/.pnpm/@tanstack+query-core@5.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:603
Inherited from
DistributiveOmit.queryFn
queryHash?
optional
queryHash:string
Defined in: node_modules/.pnpm/@tanstack+query-core@5.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:605
Inherited from
DistributiveOmit.queryHash
queryKeyHashFn?
optional
queryKeyHashFn:QueryKeyHashFunction
<any
>
Defined in: node_modules/.pnpm/@tanstack+query-core@5.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:607
Inherited from
DistributiveOmit.queryKeyHashFn
retry?
optional
retry:RetryValue
<TError
>
Defined in: node_modules/.pnpm/@tanstack+query-core@5.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:593
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.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:594
Inherited from
DistributiveOmit.retryDelay
staleTime?
optional
staleTime:StaleTime
<TOutput
,TError
,TData
,any
>
Defined in: node_modules/.pnpm/@tanstack+query-core@5.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:748
The time in milliseconds after data is considered stale. If the data is fresh it will be returned from the cache.
Inherited from
DistributiveOmit.staleTime
structuralSharing?
optional
structuralSharing:boolean
| (oldData
,newData
) =>unknown
Defined in: node_modules/.pnpm/@tanstack+query-core@5.76.0/node_modules/@tanstack/query-core/build/legacy/hydration-BaHDIfRR.d.ts:616
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
trpc?
optional
trpc:TRPCReactRequestOptions
Defined in: packages/react-query/src/shared/hooks/types.ts:58
tRPC-related options