バージョン: 11.x

インターフェース: UseTRPCSuspenseQueryOptions`<TOutput, TData, TError>`

拡張

DistributiveOmit< UseSuspenseQueryOptions< TOutput, TError, TData, any>, "queryKey">.TRPCUseQueryBaseOptions

型パラメータ

パラメータ
`TOutput`
`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

_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, TOutput, 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: TOutput| InitialDataFunction< TOutput>

ソース

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

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: (queryFn, context, query) => NoInfer< TOutput> | Promise< NoInfer< TOutput> >

パラメータ

パラメータ	型
`queryFn`	`QueryFunction`< `NoInfer`< `TOutput`>, `any`, `never`>
`context`	`object`
`context.meta`	`undefined` \| `Record`< `string`, `unknown`>
`context.queryKey`	`any`
`context.signal`	`AbortSignal`
`query`	`Query`< `unknown`, `Error`, `unknown`, `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

queryFn

optional queryFn: typeof skipToken| 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

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) => TData

このオプションは、クエリ関数によって返されたデータを変換または選択するために使用できます。

パラメーター

パラメータ	型
`data`	`TOutput`

戻り値

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

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

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

optional trpc: TRPCReactRequestOptions

tRPC関連のオプション

ソース

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

継承元

TRPCUseQueryBaseOptionsのtrpc

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

インターフェース: UseTRPCSuspenseQueryOptions<TOutput, TData, TError>

拡張​

型パラメータ​

プロパティ​

_defaulted​

ソース​

継承元​

_optimisticResults​

ソース​

継承元​

behavior​

ソース​

継承元​

gcTime​

ソース​

継承元​

initialData​

ソース​

継承元​

initialDataUpdatedAt​

ソース​

継承元​

maxPages​

ソース​

継承元​

meta​

ソース​

継承元​

networkMode​

ソース​

継承元​

notifyOnChangeProps​

ソース​

継承元​

persister​

パラメータ​

戻り値​

ソース​

継承元​

queryFn​

ソース​

継承元​

queryHash​

ソース​

継承元​

queryKeyHashFn​

ソース​

継承元​

refetchInterval​

ソース​

継承元​

refetchIntervalInBackground​

ソース​

継承元​

refetchOnMount​

ソース​

継承元​

refetchOnReconnect​

ソース​

継承元​

refetchOnWindowFocus​

ソース​

継承元​

retry​

ソース​

継承元​

retryDelay​

ソース​

継承元​

retryOnMount​

ソース​

継承元​

select​

パラメーター​

戻り値​

ソース​

継承元​

staleTime​

ソース​

継承元​

インターフェース: UseTRPCSuspenseQueryOptions`<TOutput, TData, TError>`

拡張

型パラメータ

プロパティ

_defaulted

ソース

継承元

_optimisticResults

ソース

継承元

behavior

ソース

継承元

gcTime

ソース

継承元

initialData

ソース

継承元

initialDataUpdatedAt

ソース

継承元

maxPages

ソース

継承元

meta

ソース

継承元

networkMode

ソース

継承元

notifyOnChangeProps

ソース

継承元

persister

パラメータ

戻り値

ソース

継承元

queryFn

ソース

継承元

queryHash

ソース

継承元

queryKeyHashFn

ソース

継承元

refetchInterval

ソース

継承元

refetchIntervalInBackground

ソース

継承元

refetchOnMount

ソース

継承元

refetchOnReconnect

ソース

継承元

refetchOnWindowFocus

ソース

継承元

retry

ソース

継承元

retryDelay

ソース

継承元

retryOnMount

ソース

継承元

select

パラメーター

戻り値

ソース

継承元

staleTime

ソース

継承元