接口: UseTRPCSuspenseInfiniteQueryOptions<TInput, TOutput, TError>

扩展

• DistributiveOmit< UseSuspenseInfiniteQueryOptions< TOutput, TError, TOutput, TOutput, any, ExtractCursorType< TInput> >, "queryKey"| "initialPageParam" >.TRPCUseQueryBaseOptions

类型参数

参数
TInput
TOutput
TError

属性

_defaulted

optional _defaulted: boolean

来源

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

继承自

DistributiveOmit._defaulted

---

_optimisticResults

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

optional behavior: QueryBehavior< TOutput, TError, InfiniteData< TOutput, ExtractCursorType< TInput> >, 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

optional gcTime: number

未使用的/非活动缓存数据保留在内存中的时间（以毫秒为单位）。当查询的缓存变得未使用或非活动时，该缓存数据将在此持续时间后被垃圾回收。当指定不同的垃圾回收时间时，将使用最长的一个。将其设置为 Infinity 将禁用垃圾回收。

来源

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

继承自

DistributiveOmit.gcTime

---

getNextPageParam

getNextPageParam: GetNextPageParamFunction< ExtractCursorType< TInput>, TOutput>

此函数可以设置为自动获取无限查询的下一个游标。结果还将用于确定 hasNextPage 的值。

来源

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

继承自

DistributiveOmit.getNextPageParam

---

getPreviousPageParam

optional getPreviousPageParam: GetPreviousPageParamFunction< ExtractCursorType< TInput>, TOutput>

此函数可以设置为自动获取无限查询的先前游标。结果还将用于确定 hasPreviousPage 的值。

来源

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

继承自

DistributiveOmit.getPreviousPageParam

---

initialCursor

optional initialCursor: ExtractCursorType< TInput>

来源

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

---

initialData

optional initialData: InfiniteData< TOutput, ExtractCursorType< TInput> > | InitialDataFunction< InfiniteData< TOutput, ExtractCursorType< TInput> > >

来源

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

继承自

DistributiveOmit.initialData

---

initialDataUpdatedAt

optional initialDataUpdatedAt: number|() => undefined| number

来源

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

继承自

DistributiveOmit.initialDataUpdatedAt

---

maxPages

optional maxPages: number

无限查询数据中要存储的页面最大数量。

来源

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

继承自

DistributiveOmit.maxPages

---

meta

optional meta: Record< string, unknown>

要存储在每个查询上的附加有效负载。使用此属性传递可以在其他地方使用的信息。

来源

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

继承自

DistributiveOmit.meta

---

networkMode

optional 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

optional 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

optional persister: QueryPersister< NoInfer< TOutput>, any, NoInfer< ExtractCursorType< TInput> > >

来源

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

继承自

DistributiveOmit.persister

---

queryFn

optional queryFn: typeof skipToken| QueryFunction< TOutput, any, ExtractCursorType< TInput> >

来源

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| number | 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) => TOutput

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

参数

参数	类型
data	InfiniteData< TOutput, ExtractCursorType< TInput> >

返回值

TOutput

来源

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