接口: UseTRPCQueryOptions<TOutput, TData, TError, TQueryOptsData>
扩展
DistributiveOmit<UseBaseQueryOptions<TOutput,TError,TData,TQueryOptsData,any>,"queryKey">.TRPCUseQueryBaseOptions
类型参数
| 参数 | 默认值 |
|---|---|
TOutput | - |
TData | - |
TError | - |
TQueryOptsData | TOutput |
属性
_defaulted
可选_defaulted:布尔值
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:314
继承自
DistributiveOmit._defaulted
_optimisticResults
可选_optimisticResults:"optimistic"|"isRestoring"
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:423
继承自
DistributiveOmit._optimisticResults
behavior
可选behavior:QueryBehavior<TOutput,TError,TQueryOptsData,any>
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:307
继承自
DistributiveOmit.behavior
enabled
可选enabled:布尔值
将此设置为 false 以禁用查询挂载或更改查询键时的自动重新获取。要重新获取查询，请使用 useQuery 实例返回的 refetch 方法。默认为 true。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:347
继承自
DistributiveOmit.enabled
gcTime
可选gcTime:数字
未用/非活动缓存数据保留在内存中的时间（以毫秒为单位）。当查询的缓存变得未用或非活动时，该缓存数据将在此持续时间后被垃圾回收。当指定不同的垃圾回收时间时，将使用最长的一个。将其设置为 Infinity 将禁用垃圾回收。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:299
继承自
DistributiveOmit.gcTime
initialData
可选initialData:TQueryOptsData|InitialDataFunction<TQueryOptsData>
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:305
继承自
DistributiveOmit.initialData
initialDataUpdatedAt
可选initialDataUpdatedAt:数字|() =>未定义|数字
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:306
继承自
DistributiveOmit.initialDataUpdatedAt
maxPages
可选maxPages:数字
无限查询数据中要存储的最大页面数。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:323
继承自
DistributiveOmit.maxPages
meta
可选meta:记录<字符串,未知>
要存储在每个查询上的附加有效负载。使用此属性传递可以在其他地方使用的信息。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:319
继承自
DistributiveOmit.meta
networkMode
可选networkMode:NetworkMode
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:292
继承自
DistributiveOmit.networkMode
notifyOnChangeProps
可选notifyOnChangeProps:NotifyOnChangeProps
如果设置，组件将仅在列出的任何属性更改时重新渲染。当设置为 ['data', 'error'] 时，组件将仅在 data 或 error 属性更改时重新渲染。当设置为 'all' 时，组件将在每次更新查询时重新渲染。当设置为函数时，将执行该函数以计算属性列表。默认情况下，将跟踪对属性的访问，并且组件将仅在跟踪的属性之一更改时重新渲染。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:400
继承自
DistributiveOmit.notifyOnChangeProps
persister
可选persister: (queryFn,context,query) =>NoInfer<TOutput> |Promise<NoInfer<TOutput> >
参数
| 参数 | 类型 |
|---|---|
queryFn | QueryFunction< NoInfer< TOutput>, any, never> |
context | 对象 |
context.meta | 未定义 | 记录< 字符串, 未知> |
context.queryKey | any |
context.signal | AbortSignal |
query | Query< 未知, 错误, 未知, QueryKey> |
返回值
NoInfer< TOutput> | Promise< NoInfer< TOutput> >
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:301
继承自
DistributiveOmit.persister
placeholderData
可选placeholderData:NonFunctionGuard<TQueryOptsData> |PlaceholderDataFunction<NonFunctionGuard<TQueryOptsData>,TError,NonFunctionGuard<TQueryOptsData>,any>
如果设置，此值将用作此特定查询观察者的占位符数据，而查询仍处于 加载 数据中，并且未提供任何 initialData。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:422
继承自
DistributiveOmit.placeholderData
queryFn
可选queryFn: typeofskipToken|QueryFunction<TOutput,any,never>
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:300
继承自
DistributiveOmit.queryFn
queryHash
可选queryHash:string
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:302
继承自
DistributiveOmit.queryHash
queryKeyHashFn
可选queryKeyHashFn:QueryKeyHashFunction<any>
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:304
继承自
DistributiveOmit.queryKeyHashFn
refetchInterval
可选refetchInterval:number|false|(query) =>undefined|数字|false
如果设置为数字，查询将以毫秒为单位的频率持续重新获取。如果设置为函数，则该函数将使用最新数据和查询来计算频率。默认值为 false。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:358
继承自
DistributiveOmit.refetchInterval
refetchIntervalInBackground
可选refetchIntervalInBackground:boolean
如果设置为 true，则查询将在其选项卡/窗口处于后台时继续重新获取。默认值为 false。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:363
继承自
DistributiveOmit.refetchIntervalInBackground
refetchOnMount
可选refetchOnMount:boolean|"always"|(query) =>boolean|"always"
如果设置为 true，则查询将在挂载时重新获取数据（如果数据已过期）。如果设置为 false，则将禁用查询的附加实例以触发后台重新获取。如果设置为 'always'，则查询将在挂载时始终重新获取。如果设置为函数，则该函数将使用最新数据和查询来计算值。默认值为 true。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:387
继承自
DistributiveOmit.refetchOnMount
refetchOnReconnect
可选refetchOnReconnect:boolean|"always"|(query) =>boolean|"always"
如果设置为 true，则查询将在重新连接时重新获取数据（如果数据已过期）。如果设置为 false，则查询在重新连接时不会重新获取。如果设置为 'always'，则查询将在重新连接时始终重新获取。如果设置为函数，则该函数将使用最新数据和查询来计算值。默认值为 networkOnline 的值 (true)
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:379
继承自
DistributiveOmit.refetchOnReconnect
refetchOnWindowFocus
可选refetchOnWindowFocus:boolean|"always"|(query) =>boolean|"always"
如果设置为 true，则查询将在窗口获得焦点时重新获取数据（如果数据已过期）。如果设置为 false，则查询在窗口获得焦点时不会重新获取。如果设置为 'always'，则查询将在窗口获得焦点时始终重新获取。如果设置为函数，则该函数将使用最新数据和查询来计算值。默认值为 true。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:371
继承自
DistributiveOmit.refetchOnWindowFocus
retry
可选retry:RetryValue<TError>
如果为 false，则默认情况下失败的查询不会重试。如果为 true，则失败的查询将无限期重试。failureCount: num 如果设置为整数，例如 3，则失败的查询将重试，直到失败的查询计数达到该数字。如果设置为函数 (failureCount, error) => boolean，则失败的查询将重试，直到该函数返回 false。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:290
继承自
DistributiveOmit.retry
retryDelay
可选retryDelay:RetryDelayValue<TError>
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:291
继承自
DistributiveOmit.retryDelay
retryOnMount
可选retryOnMount:boolean
如果设置为 false，则查询在挂载时不会重试（如果包含错误）。默认值为 true。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:392
继承自
DistributiveOmit.retryOnMount
select
可选select: (data) =>TData
此选项可用于转换或选择查询函数返回的数据的一部分。
参数
| 参数 | 类型 |
|---|---|
data | TQueryOptsData |
返回值
TData
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:412
继承自
DistributiveOmit.select
staleTime
可选staleTime:number
数据被视为过期的毫秒数。如果设置为 Infinity，则数据将永远不会被视为过期。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:352
继承自
DistributiveOmit.staleTime
structuralSharing
可选structuralSharing:boolean|(oldData,newData) =>unknown
将此设置为 false 以禁用查询结果之间的结构共享。将此设置为一个函数，该函数接受旧数据和新数据并返回相同类型的已解析数据以实现自定义结构共享逻辑。默认值为 true。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:313
继承自
DistributiveOmit.structuralSharing
suspense
可选suspense:boolean
如果设置为 true，则查询将在 status === 'pending' 时挂起，并在 status === 'error' 时抛出错误。默认值为 false。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:418
继承自
DistributiveOmit.suspense
throwOnError
可选throwOnError:ThrowOnError<TOutput,TError,TQueryOptsData,any>
是否应抛出错误而不是设置 error 属性。如果设置为 true 或 suspense 为 true，则所有错误都将抛出到错误边界。如果设置为 false 且 suspense 为 false，则错误将作为状态返回。如果设置为函数，则将传递错误和查询，它应该返回一个布尔值，指示是否在错误边界中显示错误 (true) 或将错误作为状态返回 (false)。默认值为 false。
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:408
继承自
DistributiveOmit.throwOnError
trpc
可选trpc:TRPCReactRequestOptions
与 tRPC 相关的选项
来源
packages/react-query/src/shared/hooks/types.ts:55
继承自
使用 TypeDoc 和 typedoc-plugin-markdown 生成