インターフェイス: UseTRPCQueryOptions<TOutput, TData, TError, TQueryOptsData>
拡張
DistributiveOmit<UseBaseQueryOptions<TOutput,TError,TData,TQueryOptsData,any>,"queryKey">.TRPCUseQueryBaseOptions
型パラメータ
| パラメーター | デフォルト |
|---|---|
TOutput | - |
TData | - |
TError | - |
TQueryOptsData | TOutput |
プロパティ
_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"
ソース
DistributiveOmit._optimisticResults
動作
オプション動作:QueryBehavior<TOutput、TError、TQueryOptsData、任意>
出典
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:307
次のものを継承
DistributiveOmit.behavior
有効
オプション有効: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
initialData
オプションinitialData:TQueryOptsData|InitialDataFunction<TQueryOptsData>
出典
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|数字
出典
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:数値
無限フェッチのデータに格納する最大ページ数。
ソース
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<文字列,不明>
各クエリに格納される追加のペイロード。このプロパティを使用して他の場所で利用できる情報を渡すことができます。
ソース
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' に設定すると、コンポーネントはクエリが更新されるたびに再レンダリングされます。 関数に設定すると、関数が呼び出されてプロパティのリストが計算されます。 デフォルトでは、プロパティへのアクセスが追跡され、コンポーネントは追跡されたプロパティのいずれかが変更された場合にのみ再レンダリングされます。
ソース
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: (queryFn,context,query) =>NoInfer<TOutput> |Promise<NoInfer<TOutput> >
パラメータ
| パラメーター | タイプ |
|---|---|
queryFn | QueryFunction< NoInfer< TOutput>, any, never> |
context | object |
context.meta | undefined | Record< 文字列, 不明> |
context.queryKey | any |
context.signal | AbortSignal |
query | Query< 不明, Error, 不明, QueryKey> |
戻り値
NoInfer< TOutput> | Promise< NoInfer< TOutput> >
ソース
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:301
継承元
DistributiveOmit.persister
プレースホルダデータ
省略可能プレースホルダデータ:NonFunctionGuard<TQueryOptsData> |PlaceholderDataFunction<NonFunctionGuard<TQueryOptsData>,TError,NonFunctionGuard<TQueryOptsData>,any>
設定されている場合、この値はクエリがまだ ロード中 のデータであり、初期データが提供されていない間、この特定のクエリオブザーバーのプレースホルダデータとして使用されます。
ソース
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: typeofskipToken|QueryFunction<TOutput,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
オプション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|(クエリ) =>未定義|数字|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
optionalrefetchIntervalInBackground: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
optionalrefetchOnMount: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
optionalrefetchOnReconnect: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
optionalrefetchOnWindowFocus: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) =>TData
このオプションは、クエリ関数によって返されるデータの一部を変換または選択するために使用できます。
パラメータ
| パラメーター | タイプ |
|---|---|
data | TQueryOptsData |
返却
TData
ソース
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:数値
データが期限切れと見なされるまでのミリ秒単位の時間。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:ブール値|(oldData,newData) =>不明
クエリ結果間の構造的共有を無効にするには、これを 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
suspense
オプションsuspense:ブール値
true に設定すると、status === 'pending' の場合クエリはサスペンドされ、status === 'error' の場合にエラーがスローされます。デフォルトは false です。
ソース
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:418
継承元
DistributiveOmit.suspense
throwOnError
オプションthrowOnError:ThrowOnError<TOutput,TError,TQueryOptsData,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
継承先
生成元: TypeDoc および typedoc-plugin-markdown