Docs
Try Apollo Studio

ObservableQuery

API reference


ObservableQuery functions

ApolloClient Observables extend the Observables implementation provided by zen-observable. Refer to the zen-observable documentation for additional context and API options.

result(): Promise<ApolloQueryResult>

(src/core/ObservableQuery.ts, line 190)
Arguments
Name /
Type
Description
saveAsLastResult
any

Update the variables of this observable query, and fetch the new results. This method should be preferred over setVariables in most use cases.

Arguments
Name /
Type
Description
variables
Partial<TVariables>
Arguments
Name /
Type
Description
newOptions
Partial<WatchQueryOptions>

This is for internal use only. Most users should instead use refetch in order to be properly notified of results even when they come from cache.

Update the variables of this observable query, and fetch the new results if they've changed. If you want to force new results, use refetch.

Note: the next callback will not fire if the variables have not changed or if the result is coming from cache.

Note: the promise will return the old results immediately if the variables have not changed.

Note: the promise will return null immediately if the query is not active (there are no subscribers).

Arguments
Name /
Type
Description
variables
TVariables
Arguments
Name /
Type
Description
fetchMoreOptions
any
Arguments
Name /
Type
Description
mapFn
(TData, Pick<WatchQueryOptions, >) => TData
Arguments
Name /
Type
Description
pollInterval
any

Types

The current status of a query’s execution in our system.

Properties
Name /
Type
Description
data
T
error
ApolloError
errors
ReadonlyArray<GraphQLError>
loading
any
networkStatus
NetworkStatus
partial
any
Edit on GitHub
Previous
InMemoryCache
Next
Hooks