API Documentation / @pinia/colada / UseInfiniteQueryReturn
Interface: UseInfiniteQueryReturn<TData, TError, TPageParam, TDataInitial>
Return type of useQuery().
Extends
UseQueryReturn<UseInfiniteQueryData<TData,TPageParam>,TError,TDataInitial>
Type Parameters
TData
TData = unknown
TError
TError = ErrorDefault
TPageParam
TPageParam = unknown
TDataInitial
TDataInitial extends | UseInfiniteQueryData<TData, TPageParam> | undefined = undefined
Properties
asyncStatus
asyncStatus: ComputedRef<AsyncStatus>;Status of the query. Becomes 'loading' while the query is being fetched, is 'idle' otherwise.
Inherited from
data
data: ShallowRef<
| TDataInitial
| UseInfiniteQueryData<TData, TPageParam>>;The last successful data resolved by the query. Alias for state.value.data.
See
Inherited from
dataUpdatedAt
dataUpdatedAt: ShallowRef<number>;Timestamp of when data was last successfully fetched. TanStack Query compatible property.
Inherited from
error
error: ShallowRef<TError | null>;The error rejected by the query. Alias for state.value.error.
See
Inherited from
errorUpdatedAt
errorUpdatedAt: ShallowRef<number>;Timestamp of when an error last occurred. TanStack Query compatible property.
Inherited from
fetchStatus
fetchStatus: ComputedRef<FetchStatus>;TanStack Query compatible fetch status. Maps to: 'fetching' when loading, 'idle' otherwise. Note: 'paused' is not currently supported.
Inherited from
hasNextPage
hasNextPage: ShallowRef<boolean>;Whether there is a next page to load. Defined based on the result of UseInfiniteQueryOptions.getNextPageParam.
hasPreviousPage
hasPreviousPage: ShallowRef<boolean>;Whether there is a previous page to load. Defined based on the result of UseInfiniteQueryOptions.getPreviousPageParam.
isDelaying
isDelaying: ShallowRef<boolean>;Returns whether the query is currently delaying its asyncStatus from becoming 'loading'. Requires the PiniaColadaDelay plugin.
Inherited from
isError
isError: ComputedRef<boolean>;Whether the query status is 'error'. TanStack Query compatible property.
Inherited from
isFetched
isFetched: ShallowRef<boolean>;Whether the query has fetched at least once. TanStack Query compatible property.
Inherited from
isFetchedAfterMount
isFetchedAfterMount: ShallowRef<boolean>;Whether the query has fetched after component mount. TanStack Query compatible property.
Inherited from
UseQueryReturn.isFetchedAfterMount
isFetching
isFetching: ComputedRef<boolean>;Whether the query is currently fetching (asyncStatus === 'loading'). TanStack Query compatible property.
Inherited from
isLoading
isLoading: ShallowRef<boolean>;Returns whether the request is currently fetching data. Alias for asyncStatus.value === 'loading'
Inherited from
isLoadingError
isLoadingError: ComputedRef<boolean>;Whether the query errored on initial load (never had data). TanStack Query compatible property.
Inherited from
isPending
isPending: ComputedRef<boolean>;Returns whether the request is still pending its first call. Alias for status.value === 'pending'
Inherited from
isPlaceholderData
isPlaceholderData: ComputedRef<boolean>;Returns whether the data is the placeholderData.
Inherited from
UseQueryReturn.isPlaceholderData
isRefetchError
isRefetchError: ComputedRef<boolean>;Whether the query errored on refetch (had data before). TanStack Query compatible property.
Inherited from
isRefetching
isRefetching: ComputedRef<boolean>;Whether the query is refetching (fetching but not initial load). TanStack Query compatible property.
Inherited from
isRetrying
isRetrying: ShallowRef<boolean>;Whether the query is currently retrying. Requires the @pinia/colada-plugin-retry plugin.
Inherited from
isStale
isStale: ComputedRef<boolean>;Whether the query data is stale. TanStack Query compatible property.
Inherited from
isSuccess
isSuccess: ComputedRef<boolean>;Whether the query status is 'success'. TanStack Query compatible property.
Inherited from
loadNextPage
loadNextPage: (options?) => Promise<unknown>;Load the next page of data.
Parameters
options?
UseInfiniteQueryLoadMoreOptions
Returns
Promise<unknown>
loadPreviousPage
loadPreviousPage: (options?) => Promise<unknown>;Load the previous page of data. Requires UseInfiniteQueryOptions.getPreviousPageParam to be defined.
Parameters
options?
UseInfiniteQueryLoadMoreOptions
Returns
Promise<unknown>
refetch
refetch: (throwOnError?) => Promise<DataState<UseInfiniteQueryData<TData, TPageParam>, TError, TDataInitial>>;Ignores fresh data and triggers a new fetch
Parameters
throwOnError?
boolean
whether to throw an error if the fetch fails. Defaults to false
Returns
Promise<DataState<UseInfiniteQueryData<TData, TPageParam>, TError, TDataInitial>>
a promise that resolves when the fetch is done
Inherited from
refresh
refresh: (throwOnError?) => Promise<DataState<UseInfiniteQueryData<TData, TPageParam>, TError, TDataInitial>>;Ensures the current data is fresh. If the data is stale, refetch, if not return as is.
Parameters
throwOnError?
boolean
whether to throw an error if the refresh fails. Defaults to false
Returns
Promise<DataState<UseInfiniteQueryData<TData, TPageParam>, TError, TDataInitial>>
a promise that resolves when the refresh is done
Inherited from
retry?
optional retry?: object;Plain object with retry state for devtools. Only present in development mode.
isRetrying
isRetrying: boolean;retryCount
retryCount: number;retryError
retryError: unknown;Inherited from
retryCount
retryCount: ShallowRef<number>;The number of retries that have been scheduled so far. Resets on success or manual refetch. Requires the @pinia/colada-plugin-retry plugin.
Inherited from
retryError
retryError: ShallowRef<TError | null>;The error that triggered the current retry. null when not retrying or when retries are exhausted. Requires the @pinia/colada-plugin-retry plugin.
Inherited from
state
state: ComputedRef<DataState<UseInfiniteQueryData<TData, TPageParam>, TError, TDataInitial>>;The state of the query. Contains its data, error, and status.
Inherited from
status
status: ShallowRef<DataStateStatus>;The status of the query. Alias for state.value.status.