Files
apollo/docs/api/apollo-query.md
T
2019-05-02 15:45:01 +02:00

2.0 KiB

ApolloQuery component

Props

  • query: GraphQL query (transformed by graphql-tag)
  • variables: Object of GraphQL variables
  • fetchPolicy: See apollo fetchPolicy
  • pollInterval: See apollo pollInterval
  • notifyOnNetworkStatusChange: See apollo notifyOnNetworkStatusChange
  • context: See apollo context
  • skip: Boolean disabling query fetching
  • clientId: id of the Apollo Client used by the query (defined in ApolloProvider clients option)
  • deep: Boolean to use deep Vue watchers
  • tag: String HTML tag name (default: div); if falsy (for example null or undefined), the component will be renderless (the content won't be wrapped in a tag), in this case, only the first child will be rendered
  • debounce: Number of milliseconds for debouncing refetches (for example when the variables are changed)
  • throttle: Number of milliseconds for throttling refetches (for example when the variables are changed)
  • prefetch: If false, will skip prefetching during SSR

Scoped slot

  • result: Apollo Query result
    • result.data: Data returned by the query
    • result.loading: Boolean indicating that a request is in flight
    • result.error: Eventual error for the current result
    • result.networkStatus: See apollo networkStatus
  • query: Smart Query associated with the component
  • isLoading: Smart Query loading state
  • gqlError: first GraphQL error if any
  • times: number of times the result was updated

Events

  • result(resultObject)
  • error(errorObject)