Files
apollo/docs/api/dollar-apollo.md
T
Mordechai Zuber 91a5f42d47 fix(types): The typings for DollarApollo where missing getClient (#727)
* fix(types): add getClient to DollarApollo

* Add documentation for `DollarApollo.getClient`
2019-09-03 17:22:39 +02:00

1.1 KiB

Dollar Apollo

This is the Apollo manager added to any component that uses Apollo. It can be accessed inside a component with this.$apollo.

Properties

  • vm: related component
  • queries: array of the component's Smart Queries.
  • subscriptions: array of the component's Smart Subscriptions.
  • provider: injected Apollo Provider.
  • loading: whether at least one query is loading.
  • skipAllQueries: (setter) boolean to pause or unpause all Smart Queries.
  • skipAllSubscriptions: (setter) boolean to pause or unpause all Smart Subscriptions.
  • skipAll: (setter) boolean to pause or unpause all Smart Queries and Smart Subscriptions.

Methods

  • query: execute a query (see Queries).
  • mutate: execute a mutation (see Mutations).
  • subscribe: standard Apollo subscribe method (see Subscriptions).
  • addSmartQuery: manually add a Smart Query (not recommended).
  • addSmartSubscription: add a Smart Subscription (see Subscriptions).
  • getClient: returns the underlying ApolloClient.