インターフェース: 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

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

---

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

---

refetchInterval

optional 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

optional 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

optional 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

optional 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

optional 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

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

---

retryOnMount

optional 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

optional 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

optional 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

---

構造的共有

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

optional trpc: TRPCReactRequestOptions

tRPC関連オプション

ソース

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

継承元

TRPCUseQueryBaseOptions.trpc

---

TypeDoc および typedoc-plugin-markdown を使用して生成されました