Special options

The special options begin with $ in the apollo object.

• $skipAll to disable all queries and subscriptions (see below)
• $skipAllQueries to disable all queries (see below)
• $skipAllSubscriptions to disable all subscriptions (see below)
• $deep to watch with deep: true on the properties above when a function is provided
• $error to catch errors in a default handler (see error advanced options for smart queries)
• $query to apply default options to all the queries in the component

Example:

<script>
export default {
  data () {
    return {
      loading: 0,
    }
  },
  apollo: {
    $query: {
      loadingKey: 'loading',
    },
    query1: { ... },
    query2: { ... },
  },
}
</script>

You can define in the apollo provider a default set of options to apply to the apollo definitions. For example:

const apolloProvider = createApolloProvider({
  defaultClient: apolloClient,
  defaultOptions: {
    // apollo options applied to all queries in components
    $query: {
      loadingKey: 'loading',
      fetchPolicy: 'cache-and-network',
    },
  },
})

Skip all

You can disable all the queries for the component with skipAllQueries, all the subscriptions with skipAllSubscriptions and both with skipAll:

this.$apollo.skipAllQueries = true
this.$apollo.skipAllSubscriptions = true
this.$apollo.skipAll = true

You can also declare these properties in the apollo option of the component. They can be booleans:

export default {
  apollo: {
    $skipAll: true
  }
}

Or reactive functions:

export default {
  apollo: {
    $skipAll() {
      return this.foo === 42
    }
  }
}