@vue/apollo-composable / useQuery / Current

Interface: Current

Current state.

1. Operation data

error?

optional error: ErrorLike

A single ErrorLike object describing the error that occurred during the latest query execution.

For more information, see Handling operation errors.

---

isPreviousResult

isPreviousResult: boolean

If true, result was kept from the previous variables by the keepPreviousResult option, and does not correspond to the current variables.

resultState, result and partial describe the retained result, so narrowing on resultState is always safe. loading, networkStatus and error describe the request that is replacing it.

---

partial

partial: boolean

Describes whether result is a complete or partial result. This flag is only set when returnPartialData is true in query options.

Deprecated

This field will be removed in a future version of Apollo Client.

---

result

result: object | null | undefined

An object containing the result of your GraphQL query after it completes.

This value might be undefined if a query results in one or more errors (depending on the query's errorPolicy).

---

resultState

resultState: "complete" | "partial" | "empty" | "streaming"

Describes the completeness of result.

• empty: No data could be fulfilled from the cache or the result is incomplete. result is undefined.
• partial: Some data could be fulfilled from the cache but result is incomplete. This is only possible when returnPartialData is true.
• streaming: result is incomplete as a result of a deferred query and the result is still streaming in.
• complete: result is a fully satisfied query result fulfilled either from the cache or network.

2. Network info

loading

loading: boolean

If true, the query is busy. That covers a request in flight, new variables waiting out the debounce/throttle timer, and the hand-over in between, where the variables have been accepted but the request has not gone out yet.

Broader than networkStatus < 7, which describes only the request itself.

---

networkStatus

networkStatus: NetworkStatus

A number indicating the current network state of the query's associated request. See possible values.

Describes the network only: it stays ready while pending is true.

Used in conjunction with the notifyOnNetworkStatusChange option.

---

pending

pending: boolean

If true, variables have changed and a request is committed, but has not been issued yet because of the debounce or throttle option.

loading covers this window as well; use pending to tell a timer that has not elapsed apart from a request that is actually on the wire.