Skip to content

Commit

Permalink
Add <Subscription /> fetchPolicy to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hwillson committed Oct 2, 2018
1 parent 7c7661a commit 57e3e78
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/source/advanced/subscriptions.md
Expand Up @@ -161,6 +161,8 @@ The Subscription component accepts the following props. Only `subscription` and
<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>
<dt>`fetchPolicy`: FetchPolicy</dt>
<dd>How you want your component to interact with the Apollo cache. Defaults to "cache-first".</dd>
</dl>

<h3 id="render-prop">Render prop function</h3>
Expand Down
2 changes: 2 additions & 0 deletions docs/source/api/react-apollo.md
Expand Up @@ -190,6 +190,8 @@ The Subscription component accepts the following props. Only `subscription` and
<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>
<dt>`fetchPolicy`: FetchPolicy</dt>
<dd>How you want your component to interact with the Apollo cache. Defaults to "cache-first".</dd>
</dl>

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

0 comments on commit 57e3e78

Please sign in to comment.