接口: TRPCQueryOptions<TData, TError>

扩展

• DistributiveOmit< QueryOptions< TData, TError, TData, any>, "queryKey">.TRPCUseQueryBaseOptions

类型参数

参数
TData
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

---

behavior

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

---

initialData

optional initialData: TData| InitialDataFunction< TData>

来源

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

---

persister

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

参数

参数	类型
queryFn	QueryFunction< NoInfer< TData>, any, never>
context	object
context.meta	undefined | Record< string, unknown>
context.queryKey	any
context.signal	AbortSignal
query	Query< unknown, Error, unknown, QueryKey>

返回值

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

来源

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

optional 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

---

queryKey

queryKey: TRPCQueryKey

来源

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

---

queryKeyHashFn

optional 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

---

retry

optional 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

optional 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

---

structuralSharing

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