ObservableQuery

`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 97)

`getCurrentResult(): ApolloQueryResult<>`

(src/core/ObservableQuery.ts, line 128)

`refetch(variables): Promise<ApolloQueryResult>`

(src/core/ObservableQuery.ts, line 213)

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

Arguments

variables Partial<>

`setOptions(newOptions): Promise<ApolloQueryResult>`

(src/core/ObservableQuery.ts, line 406)

Arguments

newOptions Partial<WatchQueryOptions>

`setVariables(variables): Promise<>`

(src/core/ObservableQuery.ts, line 437)

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.

Arguments

variables any

`fetchMore(fetchMoreOptions): Promise<ApolloQueryResult>`

(src/core/ObservableQuery.ts, line 251)

Arguments

fetchMoreOptions any

`updateQuery(mapFn): any`

(src/core/ObservableQuery.ts, line 469)

Arguments

mapFn (any, Pick<WatchQueryOptions, "variables">) => any

`startPolling(pollInterval): any`

(src/core/ObservableQuery.ts, line 499)

Arguments

pollInterval any

`stopPolling(): any`

(src/core/ObservableQuery.ts, line 503)

`subscribeToMore(options): (Anonymous function)`

(src/core/ObservableQuery.ts, line 359)

Types

`NetworkStatus`

(src/core/networkStatus.ts, line 4)

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

`ApolloQueryResult`

(src/core/types.ts, line 19)

Properties

data T
error ApolloError
errors ReadonlyArray<GraphQLError>
loading any
networkStatus NetworkStatus
partial any

ObservableQuery