跳至主要内容
版本: 11.x

接口: UseTRPCSuspenseQueryOptions<TOutput, TData, TError>

扩展​

类型参数​

参数
TOutput
TData
TError

属性​

_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, TOutput, any>

来源​

node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:307

继承自​

DistributiveOmit.behavior

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: TOutput| InitialDataFunction< TOutput>

来源​

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

参数​

参数类型
queryFnQueryFunction< NoInfer< TOutput>, any, never>
context对象
context.meta未定义 | 记录< 字符串, 未知>
context.queryKeyany
context.signalAbortSignal
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

queryFn​

可选 queryFn: typeof skipToken| 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: 字符串

来源​

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: 数字| 错误 |(query) => 未定义| 数字 | 错误

如果设置为数字，查询将以毫秒为单位的频率持续重新获取。如果设置为函数，则该函数将使用最新数据和查询执行，以计算频率。默认值为 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

此选项可用于转换或选择查询函数返回的数据的一部分。

参数​

参数类型
dataTOutput

返回值​

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

trpc​

可选 trpc: TRPCReactRequestOptions

与 tRPC 相关的选项

来源​

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

继承自​

TRPCUseQueryBaseOptions.trpc

使用 TypeDoc 和 typedoc-plugin-markdown 生成