Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs updates for https://github.com/apollographql/react-apollo/pull/1966 #3841

Merged
merged 2 commits into from
Aug 21, 2018
Merged

Docs updates for https://github.com/apollographql/react-apollo/pull/1966 #3841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d4157f
Docs updates for https://github.com/apollographql/react-apollo/pull/1966
hwillson Aug 21, 2018
0203379
Merge branch 'master' into hwillson/subscription-callback
hwillson Aug 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
**Note:** This is a cumulative changelog that outlines all of the Apollo Client project child package changes that were bundled into a specific `apollo-client` release.

## vNext

### Apollo Client (2.4.1)

- Documentation updates. <br/>
[@hwillson](https://github.com/hwillson) in [#](https://github.com/apollographql/apollo-client/pull/)


## 2.4.0 (August 17, 2018)

### Apollo Client (2.4.0)
Expand Down
2 changes: 2 additions & 0 deletions docs/source/advanced/subscriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,8 @@ The Subscription component accepts the following props. Only `subscription` and
<dd>An object containing all of the variables your subscription needs to execute</dd>
<dt>`shouldResubscribe`: boolean | (currentProps: Object, nextProps: Object) => boolean</dt>
<dd>Determines if your subscription should be unsubscribed and subscribed again. By default, the component will only resubscribe if `variables` or `subscription` props change.</dd>
<dt>`onSubscriptionData`: (options: OnSubscriptionDataOptions<TData>) => any</dt>
<dd>Allows the registration of a callback function, that will be triggered each time the `Subscription` component receives data. The callback `options` object param consists of the current Apollo Client instance in `client`, and the received subscription data in `subscriptionData`.</dd>
</dl>

<h3 id="render-prop">Render prop function</h3>
Expand Down
2 changes: 2 additions & 0 deletions docs/source/api/react-apollo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,8 @@ The Subscription component accepts the following props. Only `subscription` and
<dd>An object containing all of the variables your subscription needs to execute</dd>
<dt>`shouldResubscribe`: boolean</dt>
<dd>Determines if your subscription should be unsubscribed and subscribed again</dd>
<dt>`onSubscriptionData`: (options: OnSubscriptionDataOptions<TData>) => any</dt>
<dd>Allows the registration of a callback function, that will be triggered each time the `Subscription` component receives data. The callback `options` object param consists of the current Apollo Client instance in `client`, and the received subscription data in `subscriptionData`.</dd>
</dl>

<h3 id="subscription-render-prop">Render prop function</h3>
Expand Down