Interface: UnusedSkipTokenTRPCQueryOptionsOut<TQueryFnData, TOutput, TError>

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

Extends

• UnusedSkipTokenOptions<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TOutput>, TRPCQueryKey>.TRPCQueryOptionsResult

Type Parameters

Type Parameter
TQueryFnData
TOutput
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

UnusedSkipTokenOptions._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

UnusedSkipTokenOptions._optimisticResults

---

behavior?

optional behavior: QueryBehavior<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TQueryFnData>, 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

UnusedSkipTokenOptions.behavior

---

enabled?

optional enabled: Enabled<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TQueryFnData>, 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

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

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

UnusedSkipTokenOptions.gcTime

---

initialData?

optional initialData: coerceAsyncIterableToArray<TQueryFnData> | InitialDataFunction<coerceAsyncIterableToArray<TQueryFnData>>

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

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

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

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

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

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

UnusedSkipTokenOptions.notifyOnChangeProps

---

persister()?

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

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

Parameters

Parameter	Type	Description
queryFn	QueryFunction<NoInfer<coerceAsyncIterableToArray<TQueryFnData>>, TRPCQueryKey, never>	-
context	{ client: QueryClient; direction: unknown; meta: undefined | Record<string, unknown>; pageParam: unknown; queryKey: TRPCQueryKey; 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	TRPCQueryKey	-
context.signal	AbortSignal	-
query	Query	-

Returns

NoInfer<coerceAsyncIterableToArray<TQueryFnData>> | Promise<NoInfer<coerceAsyncIterableToArray<TQueryFnData>>>

Inherited from

UnusedSkipTokenOptions.persister

---

placeholderData?

optional placeholderData: NonFunctionGuard<coerceAsyncIterableToArray<TQueryFnData>> | PlaceholderDataFunction<NonFunctionGuard<coerceAsyncIterableToArray<TQueryFnData>>, TError, NonFunctionGuard<coerceAsyncIterableToArray<TQueryFnData>>, 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

UnusedSkipTokenOptions.placeholderData

---

queryFn?

optional queryFn: QueryFunction<coerceAsyncIterableToArray<TQueryFnData>, TRPCQueryKey, never>

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

Inherited from

UnusedSkipTokenOptions.queryFn

---

queryHash?

optional queryHash: string

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

Inherited from

UnusedSkipTokenOptions.queryHash

---

queryKey

queryKey: TRPCQueryKey & object

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

Type declaration

[dataTagErrorSymbol]

[dataTagErrorSymbol]: TError

[dataTagSymbol]

[dataTagSymbol]: coerceAsyncIterableToArray

Overrides

UnusedSkipTokenOptions.queryKey

---

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

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

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

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

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

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

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

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

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

UnusedSkipTokenOptions.retryOnMount

---

select()?

optional select: (data) => coerceAsyncIterableToArray

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

Parameter	Type
data	coerceAsyncIterableToArray

Returns

coerceAsyncIterableToArray

Inherited from

UnusedSkipTokenOptions.select

---

staleTime?

optional staleTime: StaleTime<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TQueryFnData>, 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

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

UnusedSkipTokenOptions.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:9

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

Inherited from

UnusedSkipTokenOptions.subscribed

---

throwOnError?

optional throwOnError: ThrowOnError<coerceAsyncIterableToArray<TQueryFnData>, TError, coerceAsyncIterableToArray<TQueryFnData>, 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

UnusedSkipTokenOptions.throwOnError

---

trpc

trpc: object

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

path

path: string

Inherited from

TRPCQueryOptionsResult.trpc