Interface: UsePaginatedQueryOptions<TData, TArgs>#
Type parameters#
| Name |
|---|
TData |
TArgs |
Properties#
fetchPolicy#
• Optional fetchPolicy: PaginatedQueryFetchPolicy
Fetch Policy behavior
If using cache-and-network and merge, we recomend using the uniqBy helper included inside the merge parameters.
Defined in: react/src/query/usePaginatedQuery.ts:46
initialArgs#
• initialArgs: TArgs
Initial arguments used on first request
Defined in: react/src/query/usePaginatedQuery.ts:34
merge#
• Optional merge: (params: UsePaginatedQueryMergeParams<TData>) => undefined | void | TData
Custom merge function
Type declaration:#
â–¸ (params: UsePaginatedQueryMergeParams<TData>): undefined | void | TData
Parameters:#
| Name | Type |
|---|---|
params | UsePaginatedQueryMergeParams<TData> |
Returns: undefined | void | TData
Defined in: react/src/query/usePaginatedQuery.ts:38
skip#
• Optional skip: boolean
Skip initial query call
default false
Defined in: react/src/query/usePaginatedQuery.ts:52
suspense#
• Optional suspense: boolean
Activate suspense on first call
Defined in: react/src/query/usePaginatedQuery.ts:56