API Documentation / @pinia/colada / useInfiniteQuery

Function: useInfiniteQuery()

function useInfiniteQuery<TResult, TError, TPage>(options): object

Experimental

Store and merge paginated data into a single cache entry. Allows to handle infinite scrolling. This is an experimental API and is subject to change.

Type Parameters

TResult

TResult

TError

TError = { custom: Error; }

TPage

TPage = unknown

Parameters

options

UseInfiniteQueryOptions<TResult, TError, undefined | TResult, TPage>

Options to configure the infinite query.

See https://github.com/posva/pinia-colada/issues/178

Returns

object

asyncStatus

asyncStatus: ComputedRef<AsyncStatus>;

Status of the query. Becomes 'loading' while the query is being fetched, is 'idle' otherwise.

data

data: ShallowRef<TPage>;

The last successful data resolved by the query. Alias for state.value.data.

See

state

error

error: ShallowRef<null | TError>;

The error rejected by the query. Alias for state.value.error.

See

state

isDelaying

isDelaying: ShallowRef<boolean>;

Returns whether the query is currently delaying its asyncStatus from becoming 'loading'. Requires the PiniaColadaDelay plugin.

isLoading

isLoading: ShallowRef<boolean>;

Returns whether the request is currently fetching data. Alias for asyncStatus.value === 'loading'

isPending

isPending: ComputedRef<boolean>;

Returns whether the request is still pending its first call. Alias for status.value === 'pending'

isPlaceholderData

isPlaceholderData: ComputedRef<boolean>;

Returns whether the data is the placeholderData.

loadMore()

loadMore: () => Promise<DataState<TPage, TError, TPage>>;

Returns

Promise<DataState<TPage, TError, TPage>>

state

state: ComputedRef<DataState<TPage, TError, TPage>>;

The state of the query. Contains its data, error, and status.

status

status: ShallowRef<DataStateStatus>;

The status of the query. Alias for state.value.status.

See

• state
• DataStateStatus