From b4d23ae3ada2daedbf5315ff897e4d6b58455489 Mon Sep 17 00:00:00 2001 From: hwillson Date: Sat, 15 Jun 2019 05:42:16 -0400 Subject: [PATCH] Add `returnPartialData` to the API docs Fix spacing --- CHANGELOG.md | 3 ++- docs/source/api/react-apollo.md | 2 ++ docs/source/essentials/queries.md | 2 ++ 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a02221bde6d..9f59d85e86c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,8 @@ ### Apollo Client (vNext) - Documentation updates.
- [@michael-watson](https://github.com/michael-watson) in [#4940](https://github.com/apollographql/apollo-client/pull/4940) + [@michael-watson](https://github.com/michael-watson) in [#4940](https://github.com/apollographql/apollo-client/pull/4940)
+ [@hwillson](https://github.com/hwillson) in [#4969](https://github.com/apollographql/apollo-client/pull/4969) ## Apollo Client (2.6.2) diff --git a/docs/source/api/react-apollo.md b/docs/source/api/react-apollo.md index e0c418d8539..d6a6b2b8184 100644 --- a/docs/source/api/react-apollo.md +++ b/docs/source/api/react-apollo.md @@ -87,6 +87,8 @@ The Query component accepts the following props. Only `query` and `children` are
If `true`, perform a query `refetch` if the query result is marked as being partial, and the returned data is reset to an empty Object by the Apollo Client `QueryManager` (due to a cache miss). The default value is `false` for backwards-compatibility's sake, but should be changed to true for most use-cases.
`client`: ApolloClient
An `ApolloClient` instance. By default `Query` uses the client passed down via context, but a different client can be passed in.
+
`returnPartialData`: boolean
+
Opt into receiving partial results from the cache for queries that are not fully satisfied by the cache. `false` by default.
### Render prop function diff --git a/docs/source/essentials/queries.md b/docs/source/essentials/queries.md index 9250786cf5f..00d4879df38 100644 --- a/docs/source/essentials/queries.md +++ b/docs/source/essentials/queries.md @@ -271,6 +271,8 @@ The Query component accepts the following props. Only `query` and `children` are
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.
partialRefetch: boolean
If true, perform a query refetch if the query result is marked as being partial, and the returned data is reset to an empty Object by the Apollo Client QueryManager (due to a cache miss). The default value is false for backwards-compatibility's sake, but should be changed to true for most use-cases.
+
returnPartialData: boolean
+
Opt into receiving partial results from the cache for queries that are not fully satisfied by the cache. false by default.
### Render prop function