Optional Internal[variablesOptionalcontextIf you're using Apollo Link, this object is the initial value of the context object that's passed along your link chain.
OptionalerrorOptionalfetchSpecifies how the query interacts with the Apollo Client cache during execution (for example, whether it checks the cache for results before sending a request to the server).
For details, see Setting a fetch policy.
The default value is cache-first.
OptionalinitialDefaults to the initial value of options.fetchPolicy, but can be explicitly configured to specify the WatchQueryFetchPolicy to revert back to whenever variables change (unless nextFetchPolicy intervenes).
OptionalnextSpecifies the FetchPolicy to be used after this query has completed.
OptionalnotifyIf true, the in-progress query's associated component re-renders whenever the network status changes or a network error occurs.
The default value is true.
OptionalpollSpecifies the interval (in milliseconds) at which the query polls for updated results.
The default value is 0 (no polling).
OptionalqueryA GraphQL query string parsed into an AST with the gql template literal.
OptionalrefetchDetermines whether events trigger refetches for the query. Provide an
object mapping each refetch event to true (enable), false (disable)
or a callback function that returns true/false to control individual
events. Provide false to disable all automatic refetch events for this
query. Provide true to enable all automatic refetch events for this query.
Provide a callback function to perform additional logic to determine
whether to enable or disable a refetch for a query.
@remarks
refetchOn inherits from defaultOptions.watchQuery.refetchOn. If
defaultOptions.watchQuery.refetchOn is not set, all refetch events are
enabled by default.
This option only has an effect when the client is configured with a
refetchEventManager.
OptionalrefetchSpecifies whether a NetworkStatus.refetch operation should merge
incoming field data with existing data, or overwrite the existing data.
Overwriting is probably preferable, but merging is currently the default
behavior, for backwards compatibility with Apollo Client 3.x.
OptionalreturnOptionalskipA callback function that's called whenever a refetch attempt occurs
while polling. If the function returns true, the refetch is
skipped and not reattempted until the next poll interval.
OptionalvariablesAn object containing all of the GraphQL variables your query requires to execute.
Each key in the object corresponds to a variable name, and that key's value corresponds to the variable value.
This API is meant for framework integrations only. Do not use for everyday use.
Indicates that the variables are unknown at the time of query creation. This option can only be set when
fetchPolicyis'standby'. Setting this totruewill preventclient.refetchQueriesfrom refetching this query before it has left the'standby'state, either by setting afetchPolicy, or by callingobservableQuery.refetch()explicitly.Changing this option after the query has been created will have no effect.