インターフェース: TRPCQueryOptions``
拡張
- `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
optionalretryDelay: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
optionalstructuralSharing: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
optionaltrpc:TRPCReactRequestOptions
tRPC関連のオプション
ソース
packages/react-query/src/shared/hooks/types.ts:55
継承元
TypeDocとtypedoc-plugin-markdownを使用して生成されました。