API Documentation / @pinia/colada / UseQueryEntryPending

Interface: UseQueryEntryPending<TData, TError, TDataInitial>

A pending request for a query entry. It's the `pending` property of UseQueryEntry.

See

UseQueryEntry

Type Parameters

TData

TData = unknown

TError

TError = unknown

TDataInitial

TDataInitial extends TData | undefined = unknown extends TData ? unknown : undefined

Properties

abortController

abortController: AbortController;

The abort controller used to cancel the request and which signal is passed to the query function.

---

refreshCall

refreshCall: Promise<DataState<TData, TError, TDataInitial>>;

The promise created by queryCache.fetch that is currently pending.

---

settled

settled: boolean;

Whether the query function has settled before state updates and cleanup.

---

when

when: number;

When was this pending object created.