Interfaces: ApolloQuery

boolean | undefined

Opt into receiving partial results from the cache for queries that are not fully satisfied by the cache.

DocumentNode | ComponentDocument<D, V> | null

A GraphQL document containing a single query.

number | undefined

The time interval (in milliseconds) on which this query should be refetched from the server.

boolean | undefined

Set to retry any partial query results.

If true, perform a query refetch if the query result is marked as being partial, and the returned data is reset to an empty Object by the Apollo Client QueryManager (due to a cache miss).

The default value is false for backwards-compatibility's sake, but should be changed to true for most use-cases.

boolean | undefined

True when the query returned partial data.

If data was read from the cache with missing fields, partial will be true. Otherwise, partial will be falsy.

ApolloQueryControllerOptions<D, V>

Inherits from ApolloControllerOptions

boolean | undefined

Whether or not updates to the network status should trigger next on the observer of this query.

boolean

When true, the component will not automatically subscribe to new data. Call the subscribe() method to do so.

WatchQueryFetchPolicy | NextFetchPolicyFunction<D, V> | undefined

Set to prevent subsequent network requests when the fetch policy is cache-and-network or network-only.

When someone chooses cache-and-network or network-only as their initial FetchPolicy, they often do not want future cache updates to trigger unconditional network requests, which is what repeatedly applying the cache-and-network or network-only policies would seem to imply. Instead, when the cache reports an update after the initial network request, it may be desirable for subsequent network requests to be triggered only if the cache result is incomplete. The nextFetchPolicy option provides a way to update options.fetchPolicy after the intial network request, without having to set options.

NetworkStatus

networkStatus is useful if you want to display a different loading indicator (or no indicator at all) depending on your network status as it provides a more detailed view into the state of a network request on your component than loading does. networkStatus is an enum with different number values between 1 and 8. These number values each represent a different network state.

1. loading: The query has never been run before and the request is now pending. A query will still have this network status even if a result was returned from the cache, but a query was dispatched anyway.
2. setVariables: If a query’s variables change and a network request was fired then the network status will be setVariables until the result of that query comes back. React users will see this when options.variables changes on their queries.
3. fetchMore: Indicates that fetchMore was called on this query and that the network request created is currently in flight.
4. refetch: It means that refetch was called on a query and the refetch request is currently in flight.
5. Unused.
6. poll: Indicates that a polling query is currently in flight. So for example if you are polling a query every 10 seconds then the network status will switch to poll every 10 seconds whenever a poll request has been sent but not resolved.
7. ready: No request is in flight for this query, and no errors happened. Everything is OK.
8. error: No request is in flight for this query, but one or more errors were detected.

If the network status is less then 7 then it is equivalent to loading being true. In fact you could replace all of your loading checks with networkStatus < 7 and you would not see a difference. It is recommended that you use loading, however.

boolean

Flags an element that's ready and able to auto subscribe

ApolloClient<NormalizedCacheObject> | null

The Apollo Client instance.

Record<string, unknown> | undefined

Context passed to the link execution chain.

Data<D> | null

The latest query data.

ComponentDocument<D, V> | null

Operation document.

GraphQL operation document i.e. query, subscription, or mutation. Must be a parsed GraphQL DocumentNode, so use graphql-tag.

Error | ApolloError | null

Latest error

ErrorPolicy | undefined

Error Policy for the operation.

Much like fetchPolicy, errorPolicy allows you to control how GraphQL errors from the server are sent to your UI code. By default, the error policy treats any GraphQL Errors as network errors and ends the request chain. It doesn't save any data in the cache, and renders your UI with the error property set to an ApolloError. By changing this policy per request, you can adjust how GraphQL Errors are managed by your UI. The possible options for errorPolicy are:

• none (default): any errors from the request are treated like runtime errors and the observable is stopped (XXX this is default to lower breaking changes going from AC 1.0 => 2.0)
• ignore: errors from the request do not stop the observable, but also don't call next
• all: errors are treated like data and will notify observables

readonly GraphQLError[]

Latest errors

string | undefined

The fetchPolicy for the query.

Determines where the client may return a result from. The options are:

• cache-first (default): return result from cache, fetch from network if cached result is not available.
• cache-and-network: return result from cache first (if it exists), then return network result once it's available.
• cache-only: return result from cache if available, fail otherwise.
• no-cache: return result from network, fail if network call doesn't succeed, don't save to cache
• network-only: return result from network, fail if network call doesn't succeed, save to cache
• standby: only for queries that aren't actively watched, but should be available for refetch and updateQueries.

boolean

Whether a request is in flight.

boolean

True when the element is connected and ready to receive its GraphQL document

Variables<D, V> | null

Query variables.

An object map from variable name to variable value, where the variables are used within the GraphQL query.

Setting variables will initiate the query, unless noAutoSubscribe is also set.

Lets you pass a GraphQL subscription and updateQuery function to subscribe to more updates for your query.

The updateQuery parameter is a function that takes the previous query data, then a { subscriptionData: TSubscriptionResult } object, and returns an object with updated query data based on the new results.

Parameters

SubscribeToMoreOptions<Data<D>, TSubscriptionVariables, TSubscriptionData>

void | (() => void)

Resets the internal state of the query and subscribes.

Parameters

Partial<SubscriptionOptions<Variables<D, V>, Data<D>>>

ObservableSubscription

Determines whether the element should attempt to subscribe i.e. begin querying Override to prevent subscribing unless your conditions are met

Parameters

Partial<SubscriptionOptions<Variables<D, V>, Data<D>>>

boolean

Update the variables of this observable query, and fetch the new results.

Parameters

Variables<D, V>

Promise<ApolloQueryResult<Data<D>>>

Optional callback for when an error occurs.

Parameters

Error

void

Optional callback for when a query is completed.

Parameters

Data<D>

void

Exposes the ObservableQuery#fetchMore method. https://www.apollographql.com/docs/react/api/core/ObservableQuery/#ObservableQuery.fetchMore

The optional updateQuery parameter is a function that takes the previous query data, then a { subscriptionData: TSubscriptionResult } object, and returns an object with updated query data based on the new results.

The optional variables parameter is an optional new variables object.

Parameters

Partial<FetchMoreParams<D, V>> | undefined

Promise<ApolloQueryResult<D>>

Executes a Query once and updates the component with the result

Parameters

Partial<QueryOptions<Variables<D, V>, Data<D>>> | undefined

Promise<ApolloQueryResult<Data<D>>>