Skip to main content
Version: 11.x

Interface: TRPCQueryOptions<TData, TError>

Extends​

Type parameters​

Parameter
TData
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

behavior​

optional behavior: QueryBehavior< TData, TError, TData, 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​

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.

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

initialData​

optional initialData: TData | InitialDataFunction< TData >

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​

optional initialDataUpdatedAt: 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​

optional maxPages: 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​

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.

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​

optional networkMode: 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

persister​

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

Parameters​

ParameterTypeDescription
queryFnQueryFunction< NoInfer< TData >, any, never >-
contextobject-
context.direction?unknownDeprecated

if you want access to the direction, you can add it to the pageParam
context.metaundefined | Record< string, unknown >-
context.pageParam?unknown-
context.queryKeyany-
context.signalAbortSignal-
queryQuery< unknown, Error, unknown, QueryKey >-

Returns​

NoInfer< TData > | Promise< NoInfer< TData > >

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​

optional queryFn: typeof skipToken | QueryFunction< TData, any, never >

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​

optional queryHash: 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

queryKey​

queryKey: TRPCQueryKey

Source​

packages/react-query/src/shared/hooks/types.ts:92

queryKeyHashFn​

optional queryKeyHashFn: 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

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.

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​

optional retryDelay: 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

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.

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​

optional trpc: TRPCReactRequestOptions

tRPC-related options

Source​

packages/react-query/src/shared/hooks/types.ts:55

Inherited from​

TRPCUseQueryBaseOptions.trpc

Generated using TypeDoc and typedoc-plugin-markdown