Interface: TRPCFetchQueryOptions<TOutput, TError>
Extends
DistributiveOmit<FetchQueryOptions<TOutput,TError>,"queryKey">.TRPCUseUtilsOptions
Type Parameters
| Type Parameter |
|---|
TOutput |
TError |
Properties
_defaulted?
optional_defaulted:boolean
Inherited from
DistributiveOmit._defaulted
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:602
behavior?
optionalbehavior:QueryBehavior<TOutput,TError,TOutput,QueryKey>
Inherited from
DistributiveOmit.behavior
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:595
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.
Inherited from
DistributiveOmit.gcTime
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:587
initialData?
optionalinitialData:TOutput|InitialDataFunction<TOutput>
Inherited from
DistributiveOmit.initialData
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:593
initialDataUpdatedAt?
optionalinitialDataUpdatedAt:number| () =>undefined|number
Inherited from
DistributiveOmit.initialDataUpdatedAt
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:594
initialPageParam?
optionalinitialPageParam:undefined
Inherited from
DistributiveOmit.initialPageParam
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:728
maxPages?
optionalmaxPages: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.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:611
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.
Inherited from
DistributiveOmit.meta
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:607
networkMode?
optionalnetworkMode:NetworkMode
Inherited from
DistributiveOmit.networkMode
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:580
persister()?
optionalpersister: (queryFn,context,query) =>NoInfer<TOutput> |Promise<NoInfer<TOutput>>
Parameters
| Parameter | Type | Description |
|---|---|---|
queryFn | QueryFunction<NoInfer<TOutput>, QueryKey, 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 | QueryKey | - |
context.signal | AbortSignal | - |
query | Query<unknown, Error, unknown, QueryKey> | - |
Returns
NoInfer<TOutput> | Promise<NoInfer<TOutput>>
Inherited from
DistributiveOmit.persister
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:589
queryFn?
optionalqueryFn: typeofskipToken|QueryFunction<TOutput,QueryKey,never>
Inherited from
DistributiveOmit.queryFn
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:588
queryHash?
optionalqueryHash:string
Inherited from
DistributiveOmit.queryHash
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:590
queryKeyHashFn?
optionalqueryKeyHashFn:QueryKeyHashFunction<QueryKey>
Inherited from
DistributiveOmit.queryKeyHashFn
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:592
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.
Inherited from
DistributiveOmit.retry
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:578
retryDelay?
optionalretryDelay:RetryDelayValue<TError>
Inherited from
DistributiveOmit.retryDelay
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:579
staleTime?
optionalstaleTime:StaleTime<TOutput,TError,TOutput,QueryKey>
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
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:733
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.
Inherited from
DistributiveOmit.structuralSharing
Defined in
node_modules/.pnpm/@tanstack+query-core@5.62.8/node_modules/@tanstack/query-core/build/legacy/hydration-DiTAi-4H.d.ts:601
trpc?
optionaltrpc:TRPCRequestOptions
tRPC-related options
Inherited from
TRPCUseUtilsOptions.trpc