API Documentation / @pinia/colada / UseInfiniteQueryReturn

Interface: UseInfiniteQueryReturn<TPage, TError>

Extends

• Omit<UseQueryReturn<TPage, TError, TPage>, "refetch" | "refresh">

Type Parameters

TPage

TPage = unknown

TError

TError = ErrorDefault

Properties

asyncStatus

asyncStatus: ComputedRef<AsyncStatus>;

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

Inherited from

Omit.asyncStatus

---

data

data: ShallowRef<TPage>;

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

See

state

Inherited from

Omit.data

---

error

error: ShallowRef<null | TError>;

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

See

state

Inherited from

Omit.error

---

isDelaying

isDelaying: ShallowRef<boolean>;

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

Inherited from

Omit.isDelaying

---

isLoading

isLoading: ShallowRef<boolean>;

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

Inherited from

Omit.isLoading

---

isPending

isPending: ComputedRef<boolean>;

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

Inherited from

Omit.isPending

---

isPlaceholderData

isPlaceholderData: ComputedRef<boolean>;

Returns whether the data is the placeholderData.

Inherited from

Omit.isPlaceholderData

---

loadMore()

loadMore: () => Promise<unknown>;

Returns

Promise<unknown>

---

state

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

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

Inherited from

Omit.state

---

status

status: ShallowRef<DataStateStatus>;

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

See

• state
• DataStateStatus

Inherited from

Omit.status