インターフェイス：UseTRPCInfiniteQueryOptions<TInput, TOutput, TError>

拡張

• DistributiveOmit< UseInfiniteQueryOptions< 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/@継承元の

DistributiveOmit._optimisticResults

---

動作

オプション 動作: 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

---

enabled

オプション enabled: boolean

これをfalseに設定すると、クエリがマウントされたときやクエリキーが変更されたときの自動再取得が無効になります。クエリを再取得するには、useQueryインスタンスから返されるrefetchメソッドを使用します。デフォルトはtrueです。

ソース

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

継承元の

DistributiveOmit.enabled

---

gcTime

オプション 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

オプション 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

オプション initialCursor: ExtractCursorType< TInput>

ソース

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

---

initialData

オプション 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

オプション 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

オプション 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

オプション 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

オプション 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' に設定すると、クエリが更新されるたびにコンポーネントは再レンダーします。関数が設定されると、関数は実行されてプロパティの一覧が計算されます。デフォルトでは、プロパティへのアクセスは追跡され、コンポーネントは追跡されたプロパティの 1 つが変更された場合にのみ再レンダーされます。

ソース

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

---

placeholderData

オプション placeholderData: InfiniteData< TOutput, ExtractCursorType< TInput> > | PlaceholderDataFunction< InfiniteData< TOutput, ExtractCursorType< TInput> >, TError, InfiniteData< TOutput, ExtractCursorType< TInput> >, any>

設定すると、この値はクエリがまだ loading データで initialData が提供されていない間、この特定のクエリオブザーバーのプレースホルダーデータとして使用されます。

ソース

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

継承元

DistributiveOmit.placeholderData

---

queryFn

オプション queryFn: type of 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

---

throwOnError

オプション throwOnError: ThrowOnError< TOutput, TError, InfiniteData< TOutput, ExtractCursorType< TInput> >, any>

errorプロパティを設定する代わりにエラーをスローする必要があるかどうか。trueに設定するか、suspenseがtrueの場合、すべてのエラーはエラー境界にスローされます。falseに設定し、suspenseがfalseの場合、エラーは状態として返されます。関数を設定した場合、その関数にエラーとクエリが渡され、エラー境界でエラーを表示するか（true）、エラーを状態として返すか（false）を示すブール値を返します。デフォルトはfalseです。

ソース

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

継承元

DistributiveOmit.throwOnError

---

trpc

オプション trpc: TRPCReactRequestOptions

tRPC関連のオプション

ソース

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

継承元

TRPCUseQueryBaseOptions.trpc

---

TypeDocとtypedoc-plugin-markdownを使用して生成