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(saveAsLastResult): ApolloQueryResult<>`

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

Arguments

Name /
Type Description

Name / Type	Description
`saveAsLastResult` `any`

`saveAsLastResult`

any

`refetch(variables): Promise<ApolloQueryResult>`

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

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

Name / Type	Description
`variables` `Partial<>`

`variables`

Partial<>

`setOptions(newOptions): Promise<ApolloQueryResult>`

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

Arguments

Name /
Type Description

Name / Type	Description
`newOptions` `Partial<WatchQueryOptions>`

`newOptions`

Partial<WatchQueryOptions>

`setVariables(variables): Promise<>`

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

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

Name /
Type Description

Name / Type	Description
`variables` `any`

`variables`

any

`fetchMore(fetchMoreOptions): Promise<ApolloQueryResult>`

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

Arguments

Name /
Type Description

Name / Type	Description
`fetchMoreOptions` `any`

`fetchMoreOptions`

any

`updateQuery(mapFn): any`

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

Arguments

Name /
Type Description

Name / Type	Description
`mapFn` `(any, Pick<WatchQueryOptions, "variables">) => any`

`mapFn`

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

`startPolling(pollInterval): any`

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

Arguments

Name /
Type Description

Name / Type	Description
`pollInterval` `any`

`pollInterval`

any

`stopPolling(): any`

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

`subscribeToMore(options): (Anonymous function)`

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

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 21)

Properties

Name / Type	Description
`data` `any`
`error` `ApolloError`
`errors` `ReadonlyArray<GraphQLError>`
`loading` `any`
`networkStatus` `NetworkStatus`
`partial` `any`

ObservableQuery