Skip to content

Commit

Permalink
Merge pull request #3635 from apollographql/hwillson/react-api-updates
Browse files Browse the repository at this point in the history
Add `onCompleted` and `onError` props to `Query` API docs
  • Loading branch information
hwillson authored Jun 29, 2018
2 parents 7874dfb + dadc3d5 commit f2b154d
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/source/api/react-apollo.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@ The Query component accepts the following props. Only `query` and `children` are
<dd>The name of your component to be displayed in React DevTools. Defaults to 'Query'.</dd>
<dt>`skip`: boolean</dt>
<dd>If skip is true, the query will be skipped entirely.</dd>
<dt>`onCompleted`: (data: TData | {}) => void</dt>
<dd>A callback executed once your query successfully completes.</dd>
<dt>`onError`: (error: ApolloError) => void</dt>
<dd>A callback executed in the event of an error.</dd>
<dt>`context`: Record<string, any></dt>
<dd>Shared context between your Query component and your network interface (Apollo Link). Useful for setting headers from props or sending information to the `request` function of Apollo Boost.</dd>
</dl>
Expand Down

0 comments on commit f2b154d

Please sign in to comment.