API Documentation / @pinia/colada / UseQueryStateReturn

Interface: UseQueryStateReturn<TData, TError, TDataInitial>

Return type for the useQueryState composable.

See

useQueryState

Type Parameters

TData

TData = unknown

TError

TError = ErrorDefault

TDataInitial

TDataInitial extends TData | undefined = undefined

Properties

asyncStatus

asyncStatus: ComputedRef<AsyncStatus | undefined>;

asyncStatus of the query entry.

See

• AsyncStatus
• UseQueryReturn#asyncStatus

---

data

data: ComputedRef<TData | TDataInitial | undefined>;

data of the query entry.

See

UseQueryReturn#data

---

error

error: ComputedRef<TError | null | undefined>;

error of the query entry.

See

UseQueryReturn#error

---

isPending

isPending: ComputedRef<boolean>;

Is the query entry currently pending or non existent.

---

state

state: ComputedRef<
  | DataState<TData, TError, TDataInitial>
| undefined>;

state of the query entry.

See

UseQueryReturn#state

---

status

status: ComputedRef<DataStateStatus | undefined>;

status of the query entry.

See

• DataStateStatus
• UseQueryReturn#status